Skip to content

DOC: DataFrame.any() and DataFrame.all() documentation specifies the wrong return types #57088

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

Jump to bottom
Closed
1 task done
caneff opened this issue Jan 26, 2024 · 6 comments · Fixed by #58091
Closed
1 task done

DOC: DataFrame.any() and DataFrame.all() documentation specifies the wrong return types #57088

caneff opened this issue Jan 26, 2024 · 6 comments · Fixed by #58091
Assignees
@StephenLHChan @sammig6i
Labels
Docs good first issue Reduction Operations sum, mean, min, max, etc.

Comments

@caneff
Copy link
Contributor

caneff commented Jan 26, 2024

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.any.html
https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.all.html

Documentation problem

The documentation specifies that the return type is either a DataFrame or Series, but the code specifies a Series or bool.

Series or bool is correct, and the level argument mentioned in the code no longer exists.

Suggested fix for documentation

Returns:
DataFrame or scalar
If axis=None, then a scalar boolean is returned. Otherwise a Series is returned with index matching the index argument.
@caneff caneff added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jan 26, 2024
@rhshadrach
Copy link
Member

Thanks for the report, agreed - cleaning this up would be most welcome!

@rhshadrach rhshadrach added good first issue Reduction Operations sum, mean, min, max, etc. and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Jan 26, 2024
@StephenLHChan
Copy link

take

@StephenLHChan StephenLHChan mentioned this issue Jan 27, 2024
Closed
5 tasks
@sammig6i
Copy link

sammig6i commented Mar 8, 2024

take

@sammig6i sammig6i mentioned this issue Mar 12, 2024
Closed
@sejalgolani2801
Copy link

Hey, I'm new to open source but my interests lie in ML. Can I work on this issue?

@mohmmadAyesh
Copy link

Hi is Can I Contribute to this issue please

@gboeker gboeker removed their assignment Mar 26, 2024
@lamprinikourou
Copy link
Contributor

Hello! Can I contribute to this issue?

lamprinikourou added a commit to lamprinikourou/pandas that referenced this issue Mar 31, 2024
@lamprinikourou
pandas-dev#57088: Changed ndim to 1, modified doc as suggested.
76432b3
@lamprinikourou lamprinikourou mentioned this issue Mar 31, 2024
Merged
1 task
mroeschke pushed a commit that referenced this issue Apr 1, 2024
@lamprinikourou
DOC: Changed ndim to 1, modified doc as suggested. #57088 (#58091)
21681ba 
* #57088: Changed ndim to 1, modified doc as suggested.

* added tab
diogomsmiranda pushed a commit to diogomsmiranda/pandas that referenced this issue Apr 1, 2024
@lamprinikourou @diogomsmiranda
DOC: Changed ndim to 1, modified doc as suggested. pandas-dev#57088 (p…
0a9a501 
…andas-dev#58091)

* pandas-dev#57088: Changed ndim to 1, modified doc as suggested.

* added tab
pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this issue May 7, 2024
@lamprinikourou @pmhatre1
DOC: Changed ndim to 1, modified doc as suggested. pandas-dev#57088 (p…
f997535 
…andas-dev#58091)

* pandas-dev#57088: Changed ndim to 1, modified doc as suggested.

* added tab
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@StephenLHChan StephenLHChan

@sammig6i sammig6i

Labels
Docs good first issue Reduction Operations sum, mean, min, max, etc.
Projects
None yet
Milestone
No milestone
8 participants
@caneff @rhshadrach @gboeker @sejalgolani2801 @mohmmadAyesh @StephenLHChan @sammig6i @lamprinikourou