Add documentation regarding dimensionless units #276
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
…on for ease of reading
|
Looks great, thanks! |
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.
Related to #274
added a note to the documentation in
set_attributes()to prompt users to use "dimensionless" for values without units.included an additional note in the warning message, triggered only when the unrecognised unit is NA.
Formatted Roxygen documentation for readability (corrected bullet points and added some bold emphasis)
Added a test for the unrecognised unit warning
Rebuilt pkdown docs, initially just to update
set_attributes()reference but seeing as docs still had the previous version, I rebuilt the lot. Perhaps you want to consider building docs with tic? (what do reckon @maelle 😉).Let me know if you want me to change anything!