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

Namedtuples for dielectric #540

Merged

Conversation

StanczakDominik
Copy link
Member

Closes #539. Names can of course probably be improved.

@codecov
Copy link

codecov bot commented Sep 22, 2018

Codecov Report

Merging #540 into master will decrease coverage by 0.32%.
The diff coverage is 100%.

Impacted file tree graph

@@            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
Impacted Files Coverage Δ
plasmapy/physics/dielectric.py 100% <100%> (ø) ⬆️
plasmapy/atomic/particle_class.py 96.57% <0%> (-3.43%) ⬇️
plasmapy/atomic/parsing.py 100% <0%> (ø) ⬆️
plasmapy/atomic/atomic.py 100% <0%> (ø) ⬆️
plasmapy/atomic/special_particles.py 100% <0%> (ø) ⬆️
plasmapy/atomic/nuclear.py 100% <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 3988303...28a1064. Read the comment docs.

@namurphy namurphy added the transport Related to plasma transport phenomena label Sep 24, 2018
@namurphy namurphy added this to To do in PlasmaPy 0.2.0 via automation Sep 24, 2018
@namurphy namurphy added this to the v0.2.0 milestone Sep 24, 2018
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 so far! The only other suggestion would be to update the docstrings.

@@ -16,6 +16,8 @@
'cold_plasma_permittivity_LRP',
'permittivity_1D_Maxwellian']

StixTensorElements = namedtuple("Result1", ["sum", "difference", "plasma"], )
RotatingTensorElements = namedtuple("Result1", ["left", "right", "plasma"], )
Copy link
Member

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"], )

Copy link
Member Author

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

Addressed by 548bd59

@StanczakDominik
Copy link
Member Author

Hey @namurphy, I think this could be merged now. :)

@StanczakDominik
Copy link
Member Author

Darn, I missed the comment you made about the docstrings. Apologies. Fixing those now.

@StanczakDominik StanczakDominik merged commit f894c1c into PlasmaPy:master Oct 12, 2018
PlasmaPy 0.2.0 automation moved this from To do to Done Oct 12, 2018
@namurphy namurphy added the needs changelog entry See: https://docs.plasmapy.org/en/latest/contributing/changelog_guide.html label May 31, 2019
@StanczakDominik StanczakDominik deleted the 539-dielectric-namedtuples branch April 30, 2020 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs changelog entry See: https://docs.plasmapy.org/en/latest/contributing/changelog_guide.html transport Related to plasma transport phenomena
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Return namedtuples in dielectric.py functions
2 participants