Skip to content

Commit d5af4a0

Browse files
committed
Update style_guide.rst
1 parent f75cfd8 commit d5af4a0

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/sphinx/source/contributing/style_guide.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,25 @@ the ``docs/readthedocs.org:pvlib-python`` link within the checks
7070
status box at the bottom of the pull request.
7171

7272

73+
.. _documentation-units:
74+
75+
Parameter names and units
76+
-------------------------
77+
78+
When specifying parameters and their units, please follow these guidelines:
79+
- Use the recommended parameter name and units by :ref:`variables_style_rules` where possible.
80+
- Enclose units in square brackets, e.g. ``[W]``.
81+
- Use unicode superscripts symbols for exponents, e.g. ````.
82+
83+
These superscripts characters are ````, ``¹``, ``²``, ``³``, ````, ````, ````, ````, ````, ````, ````, ````. Degree symbol is ``°``.
84+
85+
- 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:
86+
87+
.. code-block:: rst
88+
89+
dni : numeric
90+
Direct normal irradiance, see :term:`dni`. [Wm⁻²]
91+
7392
.. _building-the-documentation:
7493

7594
Building the documentation

0 commit comments

Comments
 (0)