Skip to content

Commit d1737e9

Browse files
committed
Update style_guide.rst
1 parent 12d8875 commit d1737e9

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/sphinx/source/contributing/style_guide.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,11 @@ Parameter names and units
7676
-------------------------
7777

7878
When specifying parameters and their units, please follow these guidelines:
79+
7980
- Use the recommended parameter name and units by :ref:`variables_style_rules` where possible.
8081
- Enclose units in square brackets, e.g. ``[W]``.
8182
- Use unicode superscripts symbols for exponents, e.g. ````.
83+
8284
These superscripts characters are ````, ``¹``, ``²``, ``³``, ````, ````, ````, ````, ````, ````, ````, ````. Degree symbol is ``°``.
8385

8486
- 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:

0 commit comments

Comments
 (0)