Skip to content

DOC: Add summary to interpolate #37042

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.

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
Oct 15, 2020

Conversation

erictleung
Copy link
Contributor

  • closes #xxxx
  • tests added / passed
  • passes black pandas
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry

The interpolate method was missing a short summary. I hope this addition is reasonable. Happy to change it with feedback.

This basic description can be useful for users who don't know what
interpolation is and this may help with SEO to search for more powerful
method than the `.fillna()` method.
In the "See Also" section of interpolate, the fillna method sounds very
similar, but it actually is more limited. So this commit makes this
distinction more clear.
Copy link
Member

@arw2019 arw2019 left a comment

Choose a reason for hiding this comment

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

Thanks @erictleung for the PR! Some comments

@jreback jreback added Docs Missing-data np.nan, pd.NaT, pd.NA, dropna, isnull, interpolate labels Oct 11, 2020
Copy link
Member

@arw2019 arw2019 left a comment

Choose a reason for hiding this comment

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

+1 on this as is

@mroeschke mroeschke merged commit d25cb8d into pandas-dev:master Oct 15, 2020
@mroeschke mroeschke added this to the 1.2 milestone Oct 15, 2020
@mroeschke
Copy link
Member

Thanks @erictleung

JulianWgs pushed a commit to JulianWgs/pandas that referenced this pull request Oct 26, 2020
* DOC: add basic description to interpolate method

This basic description can be useful for users who don't know what
interpolation is and this may help with SEO to search for more powerful
method than the `.fillna()` method.

* DOC: update fillna info to contrast interpolate

In the "See Also" section of interpolate, the fillna method sounds very
similar, but it actually is more limited. So this commit makes this
distinction more clear.

* DOC: condense interpolate method summary text

* DOC: revert description change of fillna
kesmit13 pushed a commit to kesmit13/pandas that referenced this pull request Nov 2, 2020
* DOC: add basic description to interpolate method

This basic description can be useful for users who don't know what
interpolation is and this may help with SEO to search for more powerful
method than the `.fillna()` method.

* DOC: update fillna info to contrast interpolate

In the "See Also" section of interpolate, the fillna method sounds very
similar, but it actually is more limited. So this commit makes this
distinction more clear.

* DOC: condense interpolate method summary text

* DOC: revert description change of fillna
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Missing-data np.nan, pd.NaT, pd.NA, dropna, isnull, interpolate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants