Skip to content

DOC: Remove confusing description from core.DataFrame.iterrows #37331

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 2 commits into from
Oct 24, 2020

Conversation

takegue
Copy link
Contributor

@takegue takegue commented Oct 22, 2020

Current core.DataFrame.iterrows is as follows
image

However, core.DataFrame.iterrows actually returns an iterator which yields (index, data), not (index, data, it).
This PRs remove such confusing description like [https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.iteritems.html?highlight=yields]

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

@takegue takegue force-pushed the improve-doc-takegue branch from 8f40a4f to 2e9c615 Compare October 22, 2020 06:42
@@ -971,8 +971,6 @@ def iterrows(self) -> Iterable[Tuple[Label, Series]]:
data : Series
The data of the row as a Series.

it : generator
A generator that iterates over the rows of the frame.

Copy link
Member

Choose a reason for hiding this comment

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

Could you please remove one of the empty rows? Double emtpy rows are not allowed

Copy link
Contributor Author

@takegue takegue Oct 23, 2020

Choose a reason for hiding this comment

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

Okay! Thx for your review. I'll fix it.

@jreback jreback added the Docs label Oct 23, 2020
@takegue takegue requested a review from phofl October 23, 2020 11:22
Copy link
Member

@phofl phofl left a comment

Choose a reason for hiding this comment

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

Lgtm

Edit: The failure is unrelated

@WillAyd
Copy link
Member

WillAyd commented Oct 23, 2020

lgtm whenever green. not sure CI failure was related but restarted in any case

@WillAyd WillAyd added this to the 1.2 milestone Oct 23, 2020
@jorisvandenbossche jorisvandenbossche merged commit dce547e into pandas-dev:master Oct 24, 2020
@jorisvandenbossche
Copy link
Member

Thanks @TKNGUE !

fangchenli pushed a commit to fangchenli/pandas that referenced this pull request Oct 24, 2020
JulianWgs pushed a commit to JulianWgs/pandas that referenced this pull request Oct 26, 2020
kesmit13 pushed a commit to kesmit13/pandas that referenced this pull request Nov 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants