-
-
Notifications
You must be signed in to change notification settings - Fork 18.6k
DOC: Update the pandas.Index.is_ docstring #32357
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
Conversation
74ee7e8
to
47c4df9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good though failing CI atm
|
||
See Also | ||
-------- | ||
Index.identical : Works like Index.is_ but also check metadata. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Index.identical : Works like Index.is_ but also check metadata. | |
identical : Works like ``Index.is_`` but also check metadata. |
Might fix CI
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't really understand the build error.
I think we need to keep the Index
in Index.identical
.
You can also try:
Index.identical : Works like Index.is_ but also check metadata. | |
Index.identical : Same but also checks metadata. |
@garyteofanus can you see if @WillAyd's suggestion fixes the CI? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@garyteofanus can you have a look and see if the documentation builds correctly with any of the suggested options? Would be great to get this merged.
|
||
Returns | ||
------- | ||
True if both have same underlying data, False otherwise : bool | ||
bool | ||
Boolean indicating if both object have same underlying data, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Boolean indicating if both object have same underlying data, | |
True if both object have same underlying data, False otherwise. |
|
||
See Also | ||
-------- | ||
Index.identical : Works like Index.is_ but also check metadata. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't really understand the build error.
I think we need to keep the Index
in Index.identical
.
You can also try:
Index.identical : Works like Index.is_ but also check metadata. | |
Index.identical : Same but also checks metadata. |
Closing as stale. @garyteofanus let us know if you finally want to finish this. |
I'll submit a new pull request for this today as part of PyData Amsterdam sprint. |
black pandas
git diff upstream/master -u -- "*.py" | flake8 --diff
Output of
python scripts/validate_docstrings.py pandas.Index.is_
: