Skip to content

DOC: Wrong examples #40362

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

Closed
jihyojeon opened this issue Mar 11, 2021 · 4 comments · Fixed by #44440
Closed

DOC: Wrong examples #40362

jihyojeon opened this issue Mar 11, 2021 · 4 comments · Fixed by #44440
Assignees
Labels
Milestone

Comments

@jihyojeon
Copy link

jihyojeon commented Mar 11, 2021

Location of the documentation

https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Index.all.html

Documentation problem

This documentation is about 'pandas.Index.all' but it has examples of 'pandas.Index.any'.
The examples of 'pandas.Index.any' are also included in its own page.

Suggested fix for documentation

Delete 'any()' examples on the documentation of 'all()', I think this is wrong place.

@jihyojeon jihyojeon added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Mar 11, 2021
@dsaxton
Copy link
Member

dsaxton commented Mar 12, 2021

I think this was likely done on purpose since the two methods are closely related

@dsaxton dsaxton removed the Needs Triage Issue that has not been reviewed by a pandas team member label Mar 12, 2021
@jihyojeon
Copy link
Author

Then it looks more reasonable to add 'all()' examples in 'any()' page, like argmin and argmax. They have both examples on both page.

@devashish-gaikwad
Copy link

devashish-gaikwad commented Apr 30, 2021

I would like to add an example of 'all' to the 'any' doc page, can I get this issue assigned to me? Provided it still has value. @dsaxton

@dsaxton
Copy link
Member

dsaxton commented Apr 30, 2021

I would like to add an example of 'all' to the 'any' doc page, can I get this issue assigned to me? Provided it still has value. @dsaxton

No problem, done. In the future feel free to simply open a PR (issue doesn't need to be assigned for someone to work on it; just be sure to reference it in your PR).

Beluuuuuuga pushed a commit to Beluuuuuuga/pandas that referenced this issue May 29, 2021
@jreback jreback added this to the 1.3 milestone Jun 4, 2021
@simonjayhawkins simonjayhawkins removed this from the 1.3 milestone Jun 8, 2021
@jreback jreback added this to the 1.4 milestone Nov 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
5 participants