Skip to content

DOC: update the pandas.core.resample.Resampler.backfill docstring #20083

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 5 commits into from
Mar 12, 2018
Merged

DOC: update the pandas.core.resample.Resampler.backfill docstring #20083

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f0859db
DOC: Resampler.backfill docstring
Mar 9, 2018
31f0e0e
Add another example and line break
Mar 9, 2018
179c4aa
Add better description, returns description and reference
Mar 10, 2018
4238938
Add citation
Mar 10, 2018
4e616f7
DOC: Improve description, add example
gcbeltramini Mar 11, 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
42 changes: 38 additions & 4 deletions pandas/core/resample.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,21 +519,55 @@ def nearest(self, limit=None):

def backfill(self, limit=None):
"""
Backward fill the values
Backward fill the values.

Copy link
Contributor

Choose a reason for hiding this comment

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

It might be interesting to add a more thorough explanation of what exactly is a backward fill for novice users who have never seem this term. Something along the lines of: 'get all the NA values and substitute with the value on the next row that has a non-NA value'

Copy link
Contributor

Choose a reason for hiding this comment

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

if you can find a wikipedia reference would be great as well.

Resample datetimelike data and fill backwards missing values if any.

Parameters
----------
limit : integer, optional
limit of how many values to fill
Limit of how many values to fill.

Returns
-------
an upsampled Series
Copy link
Contributor

@joaoavf joaoavf Mar 10, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

I've seen some examples on https://python-sprints.github.io/pandas/guide/pandas_docstring.html, which would be along the lines of:

Returns

Series
An upsampled Series with backward filled NA values


See Also
--------
Series.fillna
DataFrame.fillna
Copy link
Contributor

Choose a reason for hiding this comment

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

can you add a Resampler.pad, nearest, and fillna refs @jorisvandenbossche how do we reference these exactly here?

Copy link
Member

Choose a reason for hiding this comment

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

It might be you can simply refer to them as 'pad', 'nearest', .. because they live on the same class. But need to check.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If I run python make.py --single pandas.core.resample.Resampler.backfill, the links are never created. But if I run python make.py html, the links are created correctly if I use: pandas.Series.fillna (Series.fillna and pandas.core.series.Series.fillna don't work) and fillna or Resampler.fillna.

Series.fillna : Fill NA/NaN values in the Series using the specified
method, which can be 'backfill'.
DataFrame.fillna : Fill NA/NaN values in the DataFrame using the
specified method, which can be 'backfill'.

Examples
--------
>>> s = pd.Series([1, 2, 3],
... index=pd.date_range('20180101', periods=3, freq='h'))
>>> s
2018-01-01 00:00:00 1
2018-01-01 01:00:00 2
2018-01-01 02:00:00 3
Freq: H, dtype: int64

>>> s.resample('30min').backfill()
2018-01-01 00:00:00 1
2018-01-01 00:30:00 2
2018-01-01 01:00:00 2
2018-01-01 01:30:00 3
2018-01-01 02:00:00 3
Freq: 30T, dtype: int64

>>> s.resample('15min').backfill(limit=2)
2018-01-01 00:00:00 1.0
2018-01-01 00:15:00 NaN
2018-01-01 00:30:00 2.0
2018-01-01 00:45:00 2.0
2018-01-01 01:00:00 2.0
2018-01-01 01:15:00 NaN
2018-01-01 01:30:00 3.0
2018-01-01 01:45:00 3.0
2018-01-01 02:00:00 3.0
Freq: 15T, dtype: float64
"""
return self._upsample('backfill', limit=limit)
bfill = backfill
Expand Down