update whatsnew and add references to test docs

pvlib · kandersolar · Mar 15, 2023 · Sep 30, 2022 · Oct 5, 2022 · Oct 16, 2022
commit 5a6b631a37cace2deeae1d99544bafce0236d8e7
diff --git a/docs/sphinx/source/whatsnew/v0.9.5.rst b/docs/sphinx/source/whatsnew/v0.9.5.rst
@@ -26,9 +26,6 @@ Enhancements
   :py:func:`pvlib.bifacial.infinite_sheds.get_irradiance_poa`
   to enable use of the hay-davies sky diffuse irradiance model
   instead of the default isotropic model. (:pull:`1668`)
-* Testing :py:func:`pvlib.pvsystem.singlediode`, :py:func:`pvlib.pvsystem.v_from_i`,
-  and :py:func:`pvlib.pvsystem.i_from_v` against precisely generated IV curve data.
-  (:issue:`411`, :pull:`1573`)
 
 Bug fixes
 ~~~~~~~~~
@@ -50,6 +47,9 @@ Testing
 * Added Python 3.11 to test suite. (:pull:`1582`)
 * Updated PSM3 test data files to match the new version 3.2.2 data returned
   by the PSM3 API (:issue:`1591`, :pull:`1652`)
+* Testing :py:func:`pvlib.pvsystem.singlediode`, :py:func:`pvlib.pvsystem.v_from_i`,
+  and :py:func:`pvlib.pvsystem.i_from_v` against precisely generated IV curve data.
+  (:issue:`411`, :pull:`1573`)
 
 
 Documentation
@@ -77,4 +77,5 @@ Contributors
 * Michael Deceglie (:ghuser:`mdeceglie`)
 * Saurabh Aneja (:ghuser:`spaneja`)
 * John Moseley (:ghuser:`johnMoseleyArray`)
+* Mark Campanelli (:ghuser:`markcampanelli`)
 * Taos Transue (:ghuser:`reepoi`)
diff --git a/pvlib/tests/test_singlediode.py b/pvlib/tests/test_singlediode.py
@@ -74,16 +74,15 @@ def test_newton_fs_495(method, cec_module_fs_495):
 
 def build_precise_iv_curve_dataframe(file_csv, file_json):
     """
-    Reads a precise IV curve parameter set CSV and JSON to create a data frame.
+    Reads a precise IV curve parameter set CSV and JSON to create a DataFrame.
     The CSV contains the parameters of the single diode equation which are used
-    to generate the JSON file data. The data are calculated using the arbitrary
-    precision library `mpmath`_ with 40 decimal digits of precision in order
-    have at least 16 decimal digits of precision when they are stored in JSON.
-    The precision is sufficient for the difference between the left and right
-    side of the single diode equation to be less than :math:`1 \times 10^{-16}`
-    when the numbers from the JSON are read as mpmath floats.
-
-    .. _mpmath: mpmath.org
+    to generate the JSON data. The data are calculated using [1]_ with 40
+    decimal digits of precision in order have at least 16 decimal digits of
+    precision when they are stored in JSON. The precision is sufficient for the
+    difference between the left and right side of the single diode equation to
+    be less than :math:`1 \times 10^{-16}` when the numbers from the JSON are
+    read as mpmath floats. The code to generate these IV curve data is from
+    [2]_. The data and tests that use this function were added in :pull:`1573`.
 
     Parameters
     ----------
@@ -95,13 +94,23 @@ def build_precise_iv_curve_dataframe(file_csv, file_json):
 
     Returns
     -------
-        A data frame with these columns: ``Index``, ``photocurrent``,
+        A DataFrame with these columns: ``Index``, ``photocurrent``,
         ``saturation_current``, ``resistance_series``, ``resistance_shunt``,
         ``n``, ``cells_in_series``, ``Voltages``, ``Currents``,
         ``diode_voltage``, ``v_oc``, ``i_sc``, ``v_mp``, ``i_mp``, ``p_mp``,
         ``i_x``, ``i_xx`, ``Temperature``, ``Irradiance``, ``Sweep Direction``,
         ``Datetime``, ``Boltzmann``, ``Elementary Charge``, and ``Vth``. The
         columns ``Irradiance``, ``Sweep Direction`` are None or empty strings.
+
+    References
+    ----------
+    .. [1] The mpmath development team. (2023). mpmath: a Python library for
+       arbitrary-precision floating-point arithmetic (version 1.2.1).
+       `mpmath <mpmath.org>`_
+
+    .. [2] The ivcurves development team. (2022). Code to generate precise
+       solutions to the single diode equation.
+       `ivcurves <github.com/cwhanse/ivcurves>`_
     """
     params = pd.read_csv(file_csv)
     curves_metadata = pd.read_json(file_json)