Skip to content

Commit d4cd028

Browse files
committed
docs fixes
1 parent 106712b commit d4cd028

3 files changed

Lines changed: 17 additions & 17 deletions

File tree

docs/sphinx/source/whatsnew/v0.13.1.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Enhancements
2424
:py:func:`~pvlib.pvsystem.i_from_v`,
2525
:py:func:`~pvlib.pvsystem.v_from_i`,
2626
:py:func:`~pvlib.pvsystem.max_power_point`,
27-
:py:func:`~pvlib.singlediode.bishop88`,
27+
:py:func:`~pvlib.singlediode.bishop88_mpp`,
2828
:py:func:`~pvlib.singlediode.bishop88_v_from_i`, and
2929
:py:func:`~pvlib.singlediode.bishop88_i_from_v`. (:issue:`2497`, :pull:`2498`)
3030

pvlib/pvsystem.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2500,7 +2500,7 @@ def singlediode(photocurrent, saturation_current, resistance_series,
25002500
Determines the method used to calculate points on the IV curve. The
25012501
options are ``'lambertw'``, ``'newton'``, ``'brentq'``, or
25022502
``'chandrupatla'``.
2503-
2503+
25042504
.. note::
25052505
``'chandrupatla'`` requires scipy 1.15 or greater.
25062506

pvlib/singlediode.py

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -242,18 +242,18 @@ def bishop88_i_from_v(voltage, photocurrent, saturation_current,
242242
breakdown_exp : float, default 3.28
243243
avalanche breakdown exponent :math:`m` [unitless]
244244
method : str, default 'newton'
245-
Either ``'newton'``, ``'brentq'``, or ``'chandrupatla'``.
246-
''method'' must be ``'newton'`` if ``breakdown_factor`` is not 0.
245+
Either ``'newton'``, ``'brentq'``, or ``'chandrupatla'``.
246+
''method'' must be ``'newton'`` if ``breakdown_factor`` is not 0.
247247
248248
.. note::
249249
``'chandrupatla'`` requires scipy 1.15 or greater.
250250
251251
method_kwargs : dict, optional
252252
Keyword arguments passed to the root finder. For options, see:
253253
254-
* ``method='brentq'``: :py:func:`scipy:scipy.optimize.brentq`
255-
* ``method='newton'``: :py:func:`scipy:scipy.optimize.newton`
256-
* ``method='chandrupatla'``: :py:func:`scipy:scipy.optimize.elementwise.find_root`
254+
* ``method='brentq'``: :py:func:`scipy:scipy.optimize.brentq`
255+
* ``method='newton'``: :py:func:`scipy:scipy.optimize.newton`
256+
* ``method='chandrupatla'``: :py:func:`scipy:scipy.optimize.elementwise.find_root`
257257
258258
``'full_output': True`` is allowed, and ``optimizer_output`` would be
259259
returned. See examples section.
@@ -414,18 +414,18 @@ def bishop88_v_from_i(current, photocurrent, saturation_current,
414414
breakdown_exp : float, default 3.28
415415
avalanche breakdown exponent :math:`m` [unitless]
416416
method : str, default 'newton'
417-
Either ``'newton'``, ``'brentq'``, or ``'chandrupatla'``.
418-
''method'' must be ``'newton'`` if ``breakdown_factor`` is not 0.
417+
Either ``'newton'``, ``'brentq'``, or ``'chandrupatla'``.
418+
''method'' must be ``'newton'`` if ``breakdown_factor`` is not 0.
419419
420420
.. note::
421421
``'chandrupatla'`` requires scipy 1.15 or greater.
422422
423423
method_kwargs : dict, optional
424424
Keyword arguments passed to the root finder. For options, see:
425425
426-
* ``method='brentq'``: :py:func:`scipy:scipy.optimize.brentq`
427-
* ``method='newton'``: :py:func:`scipy:scipy.optimize.newton`
428-
* ``method='chandrupatla'``: :py:func:`scipy:scipy.optimize.elementwise.find_root`
426+
* ``method='brentq'``: :py:func:`scipy:scipy.optimize.brentq`
427+
* ``method='newton'``: :py:func:`scipy:scipy.optimize.newton`
428+
* ``method='chandrupatla'``: :py:func:`scipy:scipy.optimize.elementwise.find_root`
429429
430430
``'full_output': True`` is allowed, and ``optimizer_output`` would be
431431
returned. See examples section.
@@ -582,18 +582,18 @@ def bishop88_mpp(photocurrent, saturation_current, resistance_series,
582582
breakdown_exp : numeric, default 3.28
583583
avalanche breakdown exponent :math:`m` [unitless]
584584
method : str, default 'newton'
585-
Either ``'newton'``, ``'brentq'``, or ``'chandrupatla'``.
586-
''method'' must be ``'newton'`` if ``breakdown_factor`` is not 0.
585+
Either ``'newton'``, ``'brentq'``, or ``'chandrupatla'``.
586+
''method'' must be ``'newton'`` if ``breakdown_factor`` is not 0.
587587
588588
.. note::
589589
``'chandrupatla'`` requires scipy 1.15 or greater.
590590
591591
method_kwargs : dict, optional
592592
Keyword arguments passed to the root finder. For options, see:
593593
594-
* ``method='brentq'``: :py:func:`scipy:scipy.optimize.brentq`
595-
* ``method='newton'``: :py:func:`scipy:scipy.optimize.newton`
596-
* ``method='chandrupatla'``: :py:func:`scipy:scipy.optimize.elementwise.find_root`
594+
* ``method='brentq'``: :py:func:`scipy:scipy.optimize.brentq`
595+
* ``method='newton'``: :py:func:`scipy:scipy.optimize.newton`
596+
* ``method='chandrupatla'``: :py:func:`scipy:scipy.optimize.elementwise.find_root`
597597
598598
``'full_output': True`` is allowed, and ``optimizer_output`` would be
599599
returned. See examples section.

0 commit comments

Comments
 (0)