-
Notifications
You must be signed in to change notification settings - Fork 306
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
Update type hints and docstrings in plasmapy.formulary
#2543
Changes from 7 commits
8d28fb1
5cfc72d
6532b1d
e8ec508
9c6845e
a33ab4e
1027a3d
447f38f
cf96896
0721e4f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,20 +8,21 @@ | |
import numpy as np | ||
from astropy.constants.si import eps0, hbar | ||
|
||
from plasmapy import particles | ||
from plasmapy.formulary.collisions import frequencies, misc | ||
from plasmapy.formulary.lengths import Debye_length | ||
from plasmapy.formulary.quantum import Wigner_Seitz_radius | ||
from plasmapy.particles.decorators import particle_input | ||
from plasmapy.particles.particle_class import Particle | ||
from plasmapy.utils.decorators import validate_quantities | ||
|
||
|
||
@validate_quantities( | ||
T={"can_be_negative": False, "equivalencies": u.temperature_energy()} | ||
) | ||
@particles.particle_input | ||
@particle_input | ||
def impact_parameter_perp( | ||
T: u.Quantity[u.K], | ||
species: (particles.Particle, particles.Particle), | ||
species: (Particle, Particle), | ||
Comment on lines
-21
to
+25
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To be more consistent with the import conventions we use elsewhere. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I love it when a review is just basically import statements, it makes the review a lot easier 😆 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It makes the pull request a lot easier too! |
||
V: u.Quantity[u.m / u.s] = np.nan * u.m / u.s, | ||
) -> u.Quantity[u.m]: | ||
r""" | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a mypy error about how
plasmapy.particles
doesn't explicitly exportParticleLike
. Hence, I'm making a bunch of these import statements a lot more specific.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I remember this issue