35 improve doc strings #48
Open
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
* concatenate doc strings with trailing name * insert blank lines to improve readability
Fit text within reasonable screen width.
-delete trailing spaces
-reformat ouput of Base.print for {T<:Unit}
-correct mass unit string in printunits()
-reformat the code for initializing the different systems of units
I am temporarily exportting those elements so as to more easily debug their docstrings.
Following our discussion about moving to Unitful, I am suspending this effort for now.
This should allow the expression :(eV/c^2) to parse correctly.
|
I amended the Unit dictionary so that the tests now all pass. |
rot4te
reviewed
Sep 9, 2024
| @@ -1,47 +1,57 @@ | |||
|
|
|||
| # include("PhysicalConstants.jl") | |||
There was a problem hiding this comment.
Includes should be suppressed in the release version, as repeated includes cause errors and everything is included directly in AtomicAndPhysicalConstants.jl
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.
In addition to clarifying many of the docstrings—especially the direction in
which the conversion factor operates—I have extended the dictionary of SI
prefixes, fixed a bug (typo) in the nano prefix, improved the output formatting
of printunits(), and reformatted some of the code.
I think we can close this issue for now. Further work on the docstrings can
happen as we transition to the use of
Unitful.