Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Adam R. Jensen <[email protected]>
  • Loading branch information
echedey-ls and AdamRJensen authored Nov 28, 2024
1 parent fa25f22 commit 5f82615
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/sphinx/source/contributing/style_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,11 @@ Parameter names and units
When specifying parameters and their units, please follow these guidelines:

- Use the recommended parameter name and units listed in the :ref:`nomenclature` where applicable.
- Enclose units in square brackets, e.g. ``[W]``.
- Use unicode superscripts symbols for exponents, e.g. ````.

These superscripts characters are ````, ``¹``, ``²``, ``³``, ````, ````, ````, ````, ````, ````, ````. Degree symbol is ``°``.

- Enclose units in square brackets after the parameter description, e.g., ``Air temperature. [°C]``.
- Use unicode superscripts symbols for exponents, e.g. ``m²``.
- Numbers: ````, ``¹``, ``²``, ``³``, ````, ````, ````, ````, ````, ````
- Negative exponent: ````
- Degree symbol: ``°``
- Link to a brief description in the :ref:`variables_style_rules` section if it exists, via the sphinx role ``:term:`glossary_term```. For example, to document ``dni`` use:

.. code-block:: rst
Expand Down

0 comments on commit 5f82615

Please sign in to comment.