Skip to content

DOC: Standardize use of "Iterate" and "Iterator" in the documentation for DataFrame and Series iterators #27861

Closed
@benthayer

Description

@benthayer

Documentation for DataFrame.items() and DataFrame.iteritems() say
"Iterator over..."
while other iterators for DataFrame and Series say
"Iterate over..."

All of these methods return an iterator, so I think it would make sense to have them all say "Iterator over...", although the documentation for 4/6 of the iteration methods already use "Iterate over...".

I'm not sure if there are other methods that also create iterators that we can use to justify one over the other.

https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.items.html
https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.iteritems.html
https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.iterrows.html
https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.itertuples.html
https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Series.items.html
https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Series.iteritems.html

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions