From 907ff359d60ba57188c23c7ac3043c716f14c1d8 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Thu, 28 Nov 2024 13:49:21 +0000 Subject: [PATCH] =?UTF-8?q?Fix=20bulleted=20list=20(hopefully=20?= =?UTF-8?q?=F0=9F=99=8F=20)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/sphinx/source/contributing/style_guide.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/sphinx/source/contributing/style_guide.rst b/docs/sphinx/source/contributing/style_guide.rst index 6375ff7b9..4eea571ed 100644 --- a/docs/sphinx/source/contributing/style_guide.rst +++ b/docs/sphinx/source/contributing/style_guide.rst @@ -80,9 +80,11 @@ 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 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:`nomenclature` section if it exists, via the sphinx role ``:term:`glossary_term```. For example, to document ``dni`` use: .. code-block:: rst