Skip to content

Add missing period to pandas.Series.interpolate docstring #22217

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 4 commits into from
Aug 8, 2018
Merged

Add missing period to pandas.Series.interpolate docstring #22217

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
74a2c65
Add missing period to pandas.Series.interpolate docstring
adamjstewart Aug 6, 2018
b53645e
Add links to external scipy docs
adamjstewart Aug 6, 2018
09b99d9
:py: is already the default domain, no need to specify
adamjstewart Aug 7, 2018
2db1a0d
Replace :func: with :class: and :meth:
adamjstewart Aug 7, 2018
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
11 changes: 6 additions & 5 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6098,9 +6098,9 @@ def replace(self, to_replace=None, value=None, inplace=False, limit=None,
* 'index', 'values': use the actual numerical values of the index
* 'nearest', 'zero', 'slinear', 'quadratic', 'cubic',
'barycentric', 'polynomial' is passed to
``scipy.interpolate.interp1d``. Both 'polynomial' and 'spline'
require that you also specify an `order` (int),
e.g. df.interpolate(method='polynomial', order=4).
:func:`scipy.interpolate.interp1d`. Both 'polynomial' and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like scipy.interpolate.interp1d is a class. May be that's the problem, as it requires :class: instead of :func:?

https://docs.scipy.org/doc/scipy/reference/generated/scipy.interpolate.interp1d.html

'spline' require that you also specify an `order` (int),
e.g. ``df.interpolate(method='polynomial', order=4)``.
These use the actual numerical values of the index.
* 'krogh', 'piecewise_polynomial', 'spline', 'pchip' and 'akima'
are all wrappers around the scipy interpolation methods of
Expand All @@ -6110,13 +6110,14 @@ def replace(self, to_replace=None, value=None, inplace=False, limit=None,
<http://docs.scipy.org/doc/scipy/reference/interpolate.html#univariate-interpolation>`__
and `tutorial documentation
<http://docs.scipy.org/doc/scipy/reference/tutorial/interpolate.html>`__
* 'from_derivatives' refers to BPoly.from_derivatives which
* 'from_derivatives' refers to
:func:`scipy.interpolate.BPoly.from_derivatives` which
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And this seems to be a method, so :meth: instead of :func:.

replaces 'piecewise_polynomial' interpolation method in
scipy 0.18

.. versionadded:: 0.18.1

Added support for the 'akima' method
Added support for the 'akima' method.
Added interpolate method 'from_derivatives' which replaces
'piecewise_polynomial' in scipy 0.18; backwards-compatible with
scipy < 0.18
Expand Down