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

what is the unit of temperature defined in the Spitzer resistivity #2643

Open
Dr-yangyangzhang opened this issue Apr 18, 2024 · 1 comment
Open
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
Milestone

Comments

@Dr-yangyangzhang
Copy link

Nature of improvement

In the documentation it reads " Temperature in units of temperature."
This is not clear. Is the unit Kelven or electron volt? Both of them are units of temperatures.

Location of improvement

https://docs.plasmapy.org/en/stable/api/plasmapy.formulary.collisions.misc.Spitzer_resistivity.html#spitzer-resistivity

Additional context

No response

@Dr-yangyangzhang Dr-yangyangzhang added the docs PlasmaPy Docs at http://docs.plasmapy.org label Apr 18, 2024
@namurphy namurphy added this to the v2024.5.0 milestone Apr 18, 2024
@namurphy namurphy added the plasmapy.formulary Related to the plasmapy.formulary subpackage label Apr 18, 2024
@namurphy
Copy link
Member

Thank you for raising this issue! We should clarify that the temperature could either be in kelvin or eV (defined using astropy.units) and add an example at the bottom of the docstring that shows how to provide the temperature in eV. It'd also be worthwhile to double check that this ambiguity exists elsewhere in the documentation. Thank you again!

@namurphy namurphy added the good first issue Good first contributions for new contributors label Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

No branches or pull requests

2 participants