Skip to content

DOC: axis argument for take says None is acceptable, but that is incorrect. #61408

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
1 task done
Dr-Irv opened this issue May 8, 2025 · 1 comment · Fixed by #61411
Closed
1 task done

DOC: axis argument for take says None is acceptable, but that is incorrect. #61408

Dr-Irv opened this issue May 8, 2025 · 1 comment · Fixed by #61411
Assignees
Labels
Algos Non-arithmetic algos: value_counts, factorize, sorting, isin, clip, shift, diff Docs
Milestone

Comments

@Dr-Irv
Copy link
Contributor

Dr-Irv commented May 8, 2025

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/pandas-docs/stable/reference/api/pandas.DataFrame.take.html#pandas.DataFrame.take

Documentation problem

The axis argument is documented as: "axis {0 or ‘index’, 1 or ‘columns’, None}, default 0" . But None is not accepted. So it should be removed from the docs.

See pandas-dev/pandas-stubs#1209 (comment) for an example.

Suggested fix for documentation

Remove None from that sentence.

@Dr-Irv Dr-Irv added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels May 8, 2025
@rhshadrach
Copy link
Member

This was changed in #20179 and seems to be erroneous, even at that time.

@rhshadrach rhshadrach added Algos Non-arithmetic algos: value_counts, factorize, sorting, isin, clip, shift, diff and removed Needs Triage Issue that has not been reviewed by a pandas team member labels May 8, 2025
@arthurlw arthurlw self-assigned this May 8, 2025
@rhshadrach rhshadrach added this to the 3.0 milestone May 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Algos Non-arithmetic algos: value_counts, factorize, sorting, isin, clip, shift, diff Docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants