Add symbol attribute to CustomParticle and DimensionlessParticle #1015
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1015 +/- ##
==========================================
+ Coverage 96.62% 96.65% +0.02%
==========================================
Files 64 64
Lines 6249 6271 +22
==========================================
+ Hits 6038 6061 +23
+ Misses 211 210 -1 ☔ View full report in Codecov by Sentry. |
namurphy
added
the
plasmapy.particles
StanczakDominik
approved these changes
Feb 15, 2021
| @@ -1922,23 +1961,26 @@ def json_dict(self) -> dict: | |||
|
|
|||
| Examples | |||
| -------- | |||
| >>> custom_particle = CustomParticle(mass=5.12 * u.kg, charge=6.2 * u.C) | |||
| >>> custom_particle = CustomParticle(mass=5.12 * u.kg, charge=6.2 * u.C, symbol="ξ") | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To help
CustomParticleandDimensionlessParticlebehave a little bit more likeParticle, I've added asymbolattribute to both of these. This will give users the opportunity to define a symbol for particles that can be used in, say, plotting.