Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use more generalized keyword argument for gyroradius #1210

Merged
merged 7 commits into from Jul 25, 2021

Conversation

RAJAGOPALAN-GANGADHARAN
Copy link
Contributor

Closes #1170

Waiting for feedback on initial changes. Will proceed further with tests.

  • I have added a changelog entry for this pull request.
  • If adding new functionality, I have added tests and
    docstrings.
  • I have fixed any newly failing tests.

This commit replaces T_i paramter keyword with T for more generalization.
Adds a deprectaion warning for notifying users.
@github-actions github-actions bot added the plasmapy.formulary Related to the plasmapy.formulary subpackage label Jul 24, 2021
@RAJAGOPALAN-GANGADHARAN
Copy link
Contributor Author

Could someone please give this PR a review.

@codecov
Copy link

codecov bot commented Jul 25, 2021

Codecov Report

❗ No coverage uploaded for pull request base (main@aeab5d7). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1210   +/-   ##
=======================================
  Coverage        ?   96.98%           
=======================================
  Files           ?       71           
  Lines           ?     7030           
  Branches        ?        0           
=======================================
  Hits            ?     6818           
  Misses          ?      212           
  Partials        ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update aeab5d7...0af09fa. Read the comment docs.

Copy link
Member

@namurphy namurphy left a comment

Choose a reason for hiding this comment

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

Looks good to me! With a few slight edits it'll be ready to merge.

We use pre-commit to check that the code is formatted as expected by black and isort. We just added an option to implement these formatting fixes by including the following in a GitHub comment:

pre-commit.ci autofix

plasmapy/formulary/parameters.py Outdated Show resolved Hide resolved
changelog/1210.removal.rst Outdated Show resolved Hide resolved
plasmapy/formulary/parameters.py Outdated Show resolved Hide resolved
@namurphy
Copy link
Member

pre-commit.ci autofix

@namurphy namurphy enabled auto-merge (squash) July 25, 2021 21:12
@namurphy namurphy changed the title PR concerning issue #1170 - Use more generalized keyword argument for gyroradius. Use more generalized keyword argument for gyroradius Jul 25, 2021
@namurphy namurphy merged commit 7825bac into PlasmaPy:main Jul 25, 2021
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.

Edit gyroradius function to better indicate that it's not just for ions
2 participants