@@ -77,21 +77,19 @@ References
7777All pertinent information within a docstring should include a proper reference.
7878In pvlib-python, we are transitioning to a standardised referencing system. We
7979encourage using the `IEEE style <https://journals.ieeeauthorcenter.ieee.org/wp-content/uploads/sites/7/IEEE_Reference_Guide.pdf >`_
80- with numeric in-text citations, but overall the most important feature of all
81- references is that they include sufficient information to make locating the
82- original source as easy as possible. As a bare minimum, we advise including:
80+ with numeric in-text citations. At minimum, a reference should include:
8381
8482* Author list (can be abbreviated with et al.)
8583* Publication title
86- * Publication source (journal title, laboratory name, etc.)
84+ * Publisher (journal title, laboratory name, etc.)
8785* Year of publication
8886* DOI (if available)
8987
9088The recommended citation style for several media types is as follows:
9189
9290**Journal article **:
9391
94- Author initials. Author Surname , "Title of article," abbreviated journal
92+ Author initials and surname , "Title of article," abbreviated journal
9593 title, vol. number, issue number, page numbers, Abbreviated Month Year.
9694
9795**Book **:
@@ -136,12 +134,12 @@ using the IEEE style in a docstring::
136134
137135Things to note:
138136
139- * In text numeric citations require a number inside square brackets, followed
137+ * In- text numeric citations are a number inside square brackets, followed
140138 by an underscore, e.g. ``[1]_ ``.
141139* To include a DOI, you can use the existing ``:doi: ``
142140 `Sphinx role <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html >`_,
143141 followed by the DOI string inside a set of backticks.
144- * The citation formatting must be consistent within the same docstring, for
142+ * The citation formatting should be consistent within the same docstring, for
145143 example if you abbreviate the author list after one author in the first
146144 citation then you should do so in all citations.
147145
0 commit comments