Skip to content

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

Closed
wants to merge 1 commit into from

Conversation

garyteofanus
Copy link

Output of python scripts/validate_docstrings.py pandas.Index.is_:

################################################################################
################################## Validation ##################################
################################################################################

1 Errors found:
        No examples section found

Copy link
Member

@WillAyd WillAyd left a 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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Index.identical : Works like Index.is_ but also check metadata.
identical : Works like ``Index.is_`` but also check metadata.

Might fix CI

Copy link
Member

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:

Suggested change
Index.identical : Works like Index.is_ but also check metadata.
Index.identical : Same but also checks metadata.

@jbrockmendel
Copy link
Member

@garyteofanus can you see if @WillAyd's suggestion fixes the CI?

Copy link
Member

@datapythonista datapythonista left a 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,
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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.
Copy link
Member

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:

Suggested change
Index.identical : Works like Index.is_ but also check metadata.
Index.identical : Same but also checks metadata.

@datapythonista
Copy link
Member

Closing as stale. @garyteofanus let us know if you finally want to finish this.

@cvanweelden cvanweelden removed their assignment Jun 20, 2020
@cvanweelden
Copy link
Contributor

I'll submit a new pull request for this today as part of PyData Amsterdam sprint.

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.

6 participants