Visitar URL original
Add examples to docstring of `ForceFreeFluxRope` · Issue #2531 · PlasmaPy/PlasmaPy · GitHub
Skip to content

Add examples to docstring of ForceFreeFluxRope #2531

Description

@namurphy

Currently, the docstring for ForceFreeFluxRope (permalink) doesn't contain any examples. It would be helpful to add a simple working example that shows how to use it.

One possibility would be to adapt some of the tests.

Activity

  1. changed the title [-]Add example sections to `ForceFreeFluxRope` and its methods[/-] [+]Add examples to docstrings of `ForceFreeFluxRope` and its methods[/+] on Feb 23, 2024
  2. changed the title [-]Add examples to docstrings of `ForceFreeFluxRope` and its methods[/-] [+]Add examples to docstring of `ForceFreeFluxRope`[/+] on Feb 23, 2024
  3. added
    good first issueGood first contributions for new contributors
    docsPlasmaPy Docs at http://docs.plasmapy.org
    Plasma Lv2 | IntermediateIssues that require an intermediate knowledge of plasma physics
    Python Lv1 | BeginnerIssues that require some knowledge of Python
    Plasma Lv1 | BeginnerIssues appropriate for someone who has some knowledge of physics
    and removed
    Plasma Lv2 | IntermediateIssues that require an intermediate knowledge of plasma physics
    on Feb 23, 2024
  4. added
    effort: lowRequiring perhaps a few hours, but less than a day
    on Jun 17, 2024
  5. added a commit that references this issue on Feb 28, 2026
    dae7e9d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Plasma Lv1 | BeginnerIssues appropriate for someone who has some knowledge of physicsPython Lv1 | BeginnerIssues that require some knowledge of PythondocsPlasmaPy Docs at http://docs.plasmapy.orgeffort: lowRequiring perhaps a few hours, but less than a daygood first issueGood first contributions for new contributorsneeds description

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions