Visitar URL original
Add `mass_numb` and `Z` as parameters to functions decorated with `@particle_input` by namurphy · Pull Request #2140 · PlasmaPy/PlasmaPy · GitHub
Skip to content

Add mass_numb and Z as parameters to functions decorated with @particle_input - #2140

Merged
ejohnson-96 merged 2 commits into
PlasmaPy:mainfrom
namurphy:gyroradius-Z
May 15, 2023
Merged

ejohnson-96 merged 2 commits into
PlasmaPy:mainfrom
namurphy:gyroradius-Z

Conversation

@namurphy

Copy link
Copy Markdown
Member

If a function is decorated with @particle_input and also has mass_numb and Z as parameters to the function, then we can specify the mass number via mass_numb and charge number via Z. This PR adds mass_numb and Z to a few functions in plasampy.formulary.lengths and plasmapy.formulary.distribition since I forgot to add it before.

Follows up on #1732. Related to #341.

@github-actions

Copy link
Copy Markdown

Thank you for submitting a pull request (PR) to PlasmaPy! ✨ The future of the project depends on contributors like you, so we deeply appreciate it! 🌱

Our contributor guide has information on:

The bottom of this page shows several checks that are run for every PR. Don't worry if something broke! We break stuff all the time. 😺 Click on "Details" to learn why a check didn't pass. Please also feel free to ask for help. We do that all the time as well. 🌸 You can find us in our chat room or weekly community meeting & office hours.

  • Try fixing CI/Python 3.11 test failures first.
  • Most pre-commit.ci failures can be automagically fixed by commenting "pre-commit.ci autofix" below, followed by a git pull.
  • In the CI/Documentation ends with a cryptic error message, check out our documentation troubleshooting guide.
  • For a documentation preview, click on Details next to docs/readthedocs.org:plasmapy.

If this PR is marked as ready for review, someone should stop by soon to provide a code review and offer suggestions soon. ✅ If you don't get a review within a few weekdays, please feel free to send us a reminder.

Please also use SI units within PlasmaPy, except when there is strong justification otherwise (e.g., in some examples).

We thank you once again!

@github-actions github-actions Bot added the plasmapy.formulary Related to the plasmapy.formulary subpackage label May 15, 2023
@codecov

codecov Bot commented May 15, 2023 •

Copy link
Copy Markdown

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (010786d) 98.38% compared to head (8f7c196) 98.38%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2140   +/-   ##
=======================================
  Coverage   98.38%   98.38%           
=======================================
  Files          98       98           
  Lines        8625     8625           
=======================================
  Hits         8486     8486           
  Misses        139      139           
Impacted Files Coverage Δ
plasmapy/formulary/distribution.py 100.00% <ø> (ø)
plasmapy/formulary/lengths.py 100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@namurphy
namurphy marked this pull request as ready for review May 15, 2023 01:55
@namurphy
namurphy requested a review from a team as a code owner May 15, 2023 01:55
@namurphy
namurphy requested review from ejohnson-96 and removed request for a team May 15, 2023 01:55

@ejohnson-96 ejohnson-96 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@ejohnson-96
ejohnson-96 merged commit f5e7d72 into PlasmaPy:main May 15, 2023
@namurphy
namurphy deleted the gyroradius-Z branch May 24, 2023 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

plasmapy.formulary Related to the plasmapy.formulary subpackage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants