Skip to content
Merged
Changes from 2 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
13 changes: 6 additions & 7 deletions docs/sphinx/source/contributing/style_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,8 @@ status box at the bottom of the pull request.

References
----------
All pertinent information within a docstring should include a proper reference.
In pvlib-python, we are transitioning to a standardised referencing system. We
encourage using the `IEEE style <https://journals.ieeeauthorcenter.ieee.org/wp-content/uploads/sites/7/IEEE_Reference_Guide.pdf>`_
pvlib-python is transitioning to a standard reference format. We encourage
using the `IEEE style <https://journals.ieeeauthorcenter.ieee.org/wp-content/uploads/sites/7/IEEE_Reference_Guide.pdf>`_
with numeric in-text citations. At minimum, a reference should include:

* Author list (can be abbreviated with et al.)
Expand All @@ -100,8 +99,8 @@ The recommended citation style for several media types is as follows:

**Technical report**:

Author initials. Author Surname, “Report title” Abbrev. Name of Co.,
City of Co., Abbrev. State, Country, Rep. xxx, year
Author initials. Author Surname, “Report title” Abbrev. Name of company,
City of company, Abbrev. State, Country, Rep. xxx, year

The example below shows how to cite material and generate a reference list
using the IEEE style in a docstring::
Expand Down Expand Up @@ -129,8 +128,8 @@ using the IEEE style in a docstring::

.. [4] R. Bird, and C. Riordan, “Simple solar spectral model for direct and
diffuse irradiance on horizontal and tilted planes at the earth’s
surface for cloudless atmospheres”, NREL, CO, USA, Technical Report
TR-215-2436, 1984, :doi:`10.2172/5986936`
surface for cloudless atmospheres”, NREL, Golden, CO, USA, Technical
Report TR-215-2436, 1984, :doi:`10.2172/5986936`

Things to note:

Expand Down
Loading