Add some unicode particle aliases #1036
Merged
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
namurphy
added
the
plasmapy.particles
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1036 +/- ##
=======================================
Coverage 96.82% 96.82%
=======================================
Files 69 69
Lines 6737 6737
=======================================
Hits 6523 6523
Misses 214 214 ☔ View full report in Codecov by Sentry. |
|
I still need to add tests, which is presently giving me much-needed motivation to go to bed. |
StanczakDominik
approved these changes
Feb 24, 2021
|
Looks Good To Me Conditional On Tests Passing, But For The Changelog Entry. LGTMCOTPBFTCE. Think I'll need a macro for this... |
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.
Because I'd apparently rather play with unicode than make the increasingly wise life decision of going to bed, this pull request adds a few additional unicode particle aliases (e.g., we would be able to do
Particle("α")for an alpha particle). This could be useful for code and examples that will be read much more frequently than they are written.At present a lot of the aliases are not documented. I wonder if it would be helpful to have an
aliasesattribute toParticlethat could list all of the valid aliases for the different particles. I've also been thinking aboutunicode_symbol,mathml, andlatex_strattributes too for different representations, but that's not for this PR.