[DOC]: params & units guidelines in contributing page #2248
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
echedey-ls
changed the title
RDaxini
reviewed
Oct 9, 2024
|
|
||
| These superscripts characters are ``⁰``, ``¹``, ``²``, ``³``, ``⁴``, ``⁵``, ``⁶``, ``⁷``, ``⁸``, ``⁹``, ``⁺``, ``⁻``. Degree symbol is ``°``. | ||
|
|
||
| - Link to a brief description of the magnitude in the :ref:`variables_style_rules` section if it exists, via the sphinx role ``:term:`glossary_term```. For example, to document ``dni`` use: |
There was a problem hiding this comment.
It seems that this PR is dependent on #2234 being merged first.
Currently, the :term: example would not work with the linked variables and style rules page. I guess you know this(?) but I thought I'd highlight this just in case. The link would need to be updated to link to the glossary (or whatever we end up calling it).
I guess the alternative would be to omit this point for now, then add it in later as a follow up
There was a problem hiding this comment.
It is dependant, that's true. I'll change to draft until it gets into main to avoid making too many changes that belong to the same thing. Thanks in fact for highlighting it, when I wrote it I didn't distinguish between the two pages.
Co-Authored-By: RDaxini <[email protected]>
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.
Improve "contributing" guidelines on how to find parameter names and their units.
docs/sphinx/source/whatsnewfor all changes. Includes link to the GitHub Issue with:issue:`num`or this Pull Request with:pull:`num`. Includes contributor name and/or GitHub username (link with:ghuser:`user`).remote-data) and Milestone are assigned to the Pull Request and linked Issue.In coordination with style decided in #2234.
Makes two changes to index pages of functions, to avoid being too verbose and a typo.
Links