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.

Sign up for GitHub

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

Jump to bottom

Edit gyroradius function to better indicate that it's not just for ions #1170

Closed
namurphy opened this issue Jun 16, 2021 · 2 comments · Fixed by #1210
Closed

Edit gyroradius function to better indicate that it's not just for ions #1170

namurphy opened this issue Jun 16, 2021 · 2 comments · Fixed by #1210
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org good first issue Good first contributions for new contributors plasmapy.formulary Related to the plasmapy.formulary subpackage

Comments

@namurphy
Copy link
Member

plasmapy.formulary.gyroradius has some code within it that indicates that the particle should be an ion. In particular, one of the inputs is T_i. We should change the code and documentation to show make it more general (i.e. changing T_i to T). This would be a backwards incompatible change so we would probably want to put a deprecation warning for T_i and let T_i continue to be used for one more release.

This issue is similar to and a bit more complex than #1169.
@namurphy namurphy added docs PlasmaPy Docs at http://docs.plasmapy.org good first issue Good first contributions for new contributors plasmapy.formulary Related to the plasmapy.formulary subpackage labels Jun 16, 2021
@namurphy namurphy changed the title Edit gyroradius to better indicate that it's not just for ions Edit gyroradius function to better indicate that it's not just for ions Jun 16, 2021
@RAJAGOPALAN-GANGADHARAN
Copy link
Contributor

If this issue is up for grabs can I work on this one, Please?

@namurphy
Copy link
Member Author

@RAJAGOPALAN-GANGADHARAN — yes, please do! And thank you!

Merged
3 tasks
namurphy pushed a commit that referenced this issue Jul 25, 2021
@RAJAGOPALAN-GANGADHARAN @pre-commit-ci
PR concerning issue #1170 - Use more generalized keyword argument for…
7825bac 
… gyroradius. (#1210)

* Replace T_i with T for gyroradius fn

This commit replaces T_i paramter keyword with T for more generalization.
Adds a deprectaion warning for notifying users.

* Added changelog entry

* Added Deprecation Notice to readme docs.

* Change all instances of T_i to T in gyroradius tests

* Update changelog.rst

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@namurphy namurphy mentioned this issue Dec 1, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org good first issue Good first contributions for new contributors plasmapy.formulary Related to the plasmapy.formulary subpackage
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Use more generalized keyword argument for gyroradius RAJAGOPALAN-GANGADHARAN/PlasmaPy
3 participants
@namurphy @RAJAGOPALAN-GANGADHARAN @rocco8773