Return NaN values instead of throw exceptions for particle attributes #1825
Conversation
|
Thank you for contributing to PlasmaPy! The project's future depends deeply on contributors like you, so we deeply appreciate it! 🌱 The following checklist will be used by the code reviewer to help guide the code review process.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Thank you for making your first contribution to PlasmaPy! The project's future depends on contributors like you, so we deeply appreciate it! 🌱
To make sure that you get credit for this pull request (PR), please add yourself to the list of contributors in docs/about/credits.rst.
We encourage you to check out our contributor guide, which discusses topics like adding changelog entries. If you'd like to talk with us in real time, the easiest way is via our chat room. We also invite you to stop by our weekly community meeting or office hours.
The bottom of this page includes several checks that are run for every PR. Don't worry if something broke! We break stuff all the time. Eventually we'll want to get checks on this PR to pass before merging it. Clicking on Details next to the check will show the results of the test, including error messages. Please feel free to ask for help if you're having trouble (we do that all the time, as well).
Our testing guide describes these checks in more detail, as well as how to write and run tests. We recommend trying out test-driven development: write tests first, and then write code to make tests pass. Remember to run tests often!
As described in our documentation guide, PlasmaPy's documentation is written in reStructuredText using the numpydoc docstring standard. To see a preview of the documentation from this PR, click on Details next to the docs/readthedocs.org:plasmapy check.
To automagically fix most linter problems, comment on this PR with pre-commit.ci autofix, followed by a git pull to bring the changes home to your own computer.
A code maintainer should come by soon to begin a code review. This step often includes suggestions for fixing bugs, adding tests, or simplifying the implementation. After that you'll have a chance to make changes. If you'd like more time before a code review happens, you can convert this PR to a draft now and mark it as ready for review later.
Finally, we try to be the best community we can be. We have a Code of Conduct to foster a community of care and appreciation.
We thank you once again! ✨
|
Thank you for submitting this! The Python 3.10 tests are failing because of an unrelated issue, which should be resolved once #1822 is merged. |
There was a problem hiding this comment.
Looks good to me! I have only a few minor formatting suggestions, and the only other changes are to add a changelog entry and then add your name to the list of authors in docs/about/credits.rst if you haven't done so already. After that, it should be ready to go as soon as we make sure the tests pass. That might mean doing a git pull upstream main (where upstream is the git remote for PlasmaPy's repository) and then a git push. Thank you for doing this!
Co-authored-by: Nick Murphy <namurphy@cfa.harvard.edu>
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
Codecov ReportBase: 98.35% // Head: 98.10% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #1825 +/- ##
==========================================
- Coverage 98.35% 98.10% -0.25%
==========================================
Files 91 94 +3
Lines 8246 8304 +58
==========================================
+ Hits 8110 8147 +37
- Misses 136 157 +21
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
namurphy
added
the
plasmapy.particles
Description
In particle_class, NaN values are now returned instead of throwing exceptions.
In addition, test_atomic, test_exceptions, and test_particle_class are changed to reflect changes to particle_class and new tests are added to test_particle_class to ensure that NaN values are returned when accessing undefined properties.
Motivation and context
By returning NaN values, numpy.nan can keep track of what is undefined and what is not, avoiding dealing with exceptions as a special case. Also makes the behavior of Particles and CustomParticles more consistent
Related issues
This issue was brought up in #1016