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
Namedtuples for dielectric #540
Namedtuples for dielectric #540
Conversation
Codecov Report
@@ Coverage Diff @@
## master #540 +/- ##
==========================================
- Coverage 97.76% 97.44% -0.33%
==========================================
Files 46 46
Lines 3808 3833 +25
==========================================
+ Hits 3723 3735 +12
- Misses 85 98 +13
Continue to review full report at Codecov.
|
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.
Looks good so far! The only other suggestion would be to update the docstrings.
plasmapy/physics/dielectric.py
Outdated
@@ -16,6 +16,8 @@ | |||
'cold_plasma_permittivity_LRP', | |||
'permittivity_1D_Maxwellian'] | |||
|
|||
StixTensorElements = namedtuple("Result1", ["sum", "difference", "plasma"], ) | |||
RotatingTensorElements = namedtuple("Result1", ["left", "right", "plasma"], ) |
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.
Would this perhaps be more descriptive?
StixTensorElements = namedtuple("StixTensorElements", ["sum", "difference", "plasma"], )
RotatingTensorElements = namedtuple("RotatingTensorElements", ["left", "right", "plasma"], )
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.
Gah! Of course I would forget to change those.
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.
Addressed by 548bd59
Hey @namurphy, I think this could be merged now. :) |
Darn, I missed the comment you made about the docstrings. Apologies. Fixing those now. |
Closes #539. Names can of course probably be improved.