Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC]: params & units guidelines in contributing page #2248

Merged
merged 15 commits into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,7 @@ We strongly recommend using virtual environments for development.
Virtual environments make it easier to switch between different
versions of software. This `scientific-python.org guide
<https://learn.scientific-python.org/development/tutorials/dev-environment/>`_
is a good reference for virtual environments. The pvlib-python `installation
user guide <https://pvlib-python.readthedocs.io/en/stable/user_guide/
installation.html#set-up-a-virtual-environment>`_ also provides instructions on
is a good reference for virtual environments. The pvlib-python
:ref:`installation guide <setupenvironment>` also provides instructions on
setting up a virtual environment. If this is your first pull request, don't
worry about using a virtual environment.
23 changes: 23 additions & 0 deletions docs/sphinx/source/contributing/style_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,29 @@ the ``docs/readthedocs.org:pvlib-python`` link within the checks
status box at the bottom of the pull request.


.. _documentation-units:

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

dni : numeric
Direct normal irradiance, see :term:`dni`. [Wm⁻²]


.. _reference_style:

References
Expand Down
3 changes: 0 additions & 3 deletions docs/sphinx/source/reference/tracking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
Tracking
========

Functions
---------

.. autosummary::
:toctree: generated/

Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/source/reference/transformer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Transformer losses
==================

Methods to account for losses in transformers
Functions to account for losses in transformers

.. autosummary::
:toctree: generated/
Expand Down
Loading