8000 [DOC]: params & units guidelines in contributing page by echedey-ls · Pull Request #2248 · pvlib/pvlib-python · GitHub
[go: up one dir, main page]
Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 15 commits into from
Dec 10, 2024
Merged

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

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
f75cfd8
Fix external link that can be an internal cross reference
echedey-ls Sep 30, 2024
d5af4a0
Update style_guide.rst
echedey-ls Oct 9, 2024
842c933
Minor improvements to docs
echedey-ls Oct 9, 2024
e4629de
Update style_guide.rst
echedey-ls Oct 9, 2024
12d8875
Update style_guide.rst
echedey-ls Oct 9, 2024
d1737e9
Update style_guide.rst
echedey-ls Oct 9, 2024
f2aa750
Update style_guide.rst
echedey-ls Oct 9, 2024
52596a9
Update docs/sphinx/source/contributing/style_guide.rst
echedey-ls Nov 27, 2024
9fe7959
Merge branch 'main' into docstring-guidelines-units-etc
echedey-ls Nov 27, 2024
fa25f22
Update docs/sphinx/source/contributing/style_guide.rst
echedey-ls Nov 28, 2024
5f82615
Apply suggestions from code review
echedey-ls Nov 28, 2024
6bd2b05
Fix link variables_style_rules -> nomenclature
echedey-ls Nov 28, 2024
907ff35
Fix bulleted list (hopefully 🙏 )
echedey-ls Nov 28, 2024
30b875a
Update v0.11.2.rst
echedey-ls Dec 3, 2024
8a5d9f5
Merge branch 'main' into docstring-guidelines-units-etc
AdamRJensen Dec 4, 2024
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
Prev Previous commit
Next Next commit
Fix bulleted list (hopefully 🙏 )
  • Loading branch information
@echedey-ls
echedey-ls committed Nov 28, 2024
commit 907ff359d60ba57188c23c7ac3043c716f14c1d8
2 changes: 2 additions & 0 deletions docs/sphinx/source/contributing/style_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
0