Skip to content

DOC: operator wrapper names do not match math operators #53724

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
mk0417 opened this issue Jun 19, 2023 · 6 comments · Fixed by #53765
Closed
1 task done

DOC: operator wrapper names do not match math operators #53724

mk0417 opened this issue Jun 19, 2023 · 6 comments · Fixed by #53765
Assignees
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member

Comments

@mk0417
Copy link

mk0417 commented Jun 19, 2023

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://github.com/pandas-dev/pandas/blob/v2.0.2/pandas/core/ops/docstrings.py

Documentation problem

Among flexible wrappers (add, sub, mul, div, mod, pow) to
arithmetic operators: +, -, *, /, //, %, **.

There are 6 wrapper names, but there are 7 operators

Suggested fix for documentation

It is better to add floordiv after div so that the names can match the operators in order
Among flexible wrappers (`add`, `sub`, `mul`, `div`, `floordiv`,`mod`, `pow`) to arithmetic operators: `+`, `-`, `*`, `/`, `//`, `%`, `**`.

@mk0417 mk0417 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jun 19, 2023
@rsm-23
Copy link
Contributor

rsm-23 commented Jun 20, 2023

Thoughts @MarcoGorelli ? If the suggestion is accepted, I can take it up.

@MarcoGorelli
Copy link
Member

not sure I understand the feature request, but feel free to open a PR if you understand and think it would add value

@rsm-23
Copy link
Contributor

rsm-23 commented Jun 20, 2023

take

@rhshadrach
Copy link
Member

@mk0417 - can you give this issue a more informative title? Currently it is DOC:.

@rsm-23
Copy link
Contributor

rsm-23 commented Jun 21, 2023

I think my PR fixes what OP is requesting. Also @mk0417 can you please update the title of this issue?

@mk0417 mk0417 changed the title DOC: DOC: operation wrapper names do not match math operators Jun 21, 2023
@mk0417 mk0417 changed the title DOC: operation wrapper names do not match math operators DOC: operator wrapper names do not match math operators Jun 21, 2023
@mk0417
Copy link
Author

mk0417 commented Jun 21, 2023

Hi @rhshadrach and @rsm-23, thank you and I have updated the issue title

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants