Skip to content

DOC: improve the .equals() docstring #34498

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
jorisvandenbossche opened this issue May 31, 2020 · 1 comment · Fixed by #34508
Closed

DOC: improve the .equals() docstring #34498

jorisvandenbossche opened this issue May 31, 2020 · 1 comment · Fixed by #34508
Assignees
Milestone

Comments

@jorisvandenbossche
Copy link
Member

The current docstring for Series/DataFrame equals method can use some improvement (https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.equals.html):

  • " The column headers do not need to have the same type" is not very clear, and also doesn't apply to Series.equals. Something like "The row/column index do not need to have the same type (as long as the values are still considered equal)" might be better
  • The "Notes" section is mostly duplicating the long description at the top.
@pandeydeepak0
Copy link
Contributor

take

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants