Skip to content

DOC: Docstring updated for DataFrame.equals #34508

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

Merged
merged 7 commits into from
Aug 7, 2020
Merged

DOC: Docstring updated for DataFrame.equals #34508

merged 7 commits into from
Aug 7, 2020

Conversation

pandeydeepak0
Copy link
Contributor

@pandeydeepak0 pandeydeepak0 commented Jun 1, 2020

@pep8speaks
Copy link

pep8speaks commented Jun 1, 2020

Hello @freakypandit! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-08-07 18:32:08 UTC

Copy link
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!

Can you also update or remove the "Notes" section?

be the same dtype.
the same location are considered equal. The row/column index do not need
to have the same type (as long as the values are still considered equal).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can leave the blank line here

the same location are considered equal.

The row/column index do not need to have the same type, as long
as the values are still considered equal.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel the "still" can be removed. This was used in a different context under "Notes". It makes the sentence slightly confusing when used here. So we will have "as long as the values are considered equal".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fujiaxiang added your suggestion, thanks!

@erfannariman
Copy link
Member

erfannariman commented Jul 2, 2020

@freakypandit do you have time to finish this up, else I can pick it up.

@simonjayhawkins
Copy link
Member

@freakypandit can you fix the lint failure.

@pandeydeepak0
Copy link
Contributor Author

@simonjayhawkins I will try to do this.

@jorisvandenbossche jorisvandenbossche changed the title Docstring updated for DataFrame.equals DOC: Docstring updated for DataFrame.equals Aug 7, 2020
@jorisvandenbossche
Copy link
Member

I fixed the trailing whitespace (that was the linting failure)

@jorisvandenbossche jorisvandenbossche added this to the 1.2 milestone Aug 7, 2020
Copy link
Member

@simonjayhawkins simonjayhawkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm pending green

@jorisvandenbossche jorisvandenbossche merged commit 23dcab5 into pandas-dev:master Aug 7, 2020
@jorisvandenbossche
Copy link
Member

Thanks @freakypandit !

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

Successfully merging this pull request may close these issues.

DOC: improve the .equals() docstring
6 participants