Add docs chapter on default units and physical constants#729
Merged
giordano merged 3 commits intoJuliaPhysics:masterfrom Oct 4, 2024
Merged
Add docs chapter on default units and physical constants#729giordano merged 3 commits intoJuliaPhysics:masterfrom
giordano merged 3 commits intoJuliaPhysics:masterfrom
Conversation
Contributor
Author
|
Any chance? I created this because of the frustration due to lack of units documentation: the only way to find out being studying the source code. As Unitful belongs to the most used packages in the Julia ecosystem, one can safely assume I was not alone with my frustration. I understand automatic generation of the docs as in my PR #704 could in theory have some unexpected implications, must be thoroughly checked etc. But what could speak against merging just the docs page according to the current PR? |
This file contains hidden or 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
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.
Adding (only) documentation page on default units and physical constants, as requested in #623 - a temporary alternative to generation of this documentation as suggested in #704.
The PR #704 is somewhat stalled: Having the script to do exactly what we want might take time.
I have now manually edited the (initially generated) doc page according to @sostock remarks (#704 (comment), #704 (comment), #704 (comment)).
Could we probably merge this docs page as a provisional solution?