Skip to content

DOC: Add missing docstrings for Index.empty, Index.view and Index.names #57546

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 35 commits into from

Conversation

merlinymy
Copy link

  • [ All docstrings tests passed]

@merlinymy merlinymy requested a review from mroeschke as a code owner February 21, 2024 09:27
@datapythonista datapythonista changed the title Add missing docstrings for Index.empty, Index.view and Index.names DOC: Add missing docstrings for Index.empty, Index.view and Index.names Feb 27, 2024
@datapythonista datapythonista added Docs Index Related to the Index class or subclasses labels Feb 27, 2024
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.

Thanks for the contribution @merlinymy, great work. Can you have a look at the problems in the continuous integration and make sure everything is green, so we can review and merge this please? Thank you!

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.

Removing the tailing whitespaces and the see also section with a private method.

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.

More fixes to the docstring, so we can get it merged (author doesn't seem responsive, but there is a lot of nice work here)

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.

More fixes, removing tailing whitespaces and adding blank line between sections.

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.

I fixed all the issues here, if someone else can have a second look to see if this can be merge. The PR is stale but it's a nice addition, so I've been addressing all the issues myself.

@mroeschke
Copy link
Member

pre-commit.ci autofix

@datapythonista
Copy link
Member

/preview

@Aloqeely
Copy link
Member

I fixed all the issues here, if someone else can have a second look to see if this can be merge. The PR is stale but it's a nice addition, so I've been addressing all the issues myself.

LGTM.

@Aloqeely
Copy link
Member

Aloqeely commented May 7, 2024

@mroeschke all docstrings seem to have already been added in main, should we close this?

I think the changes here provide more info and I also see a few differences that look correct here but are wrong on main. I can follow up with a PR that will add some of the changes here to the current docstrings.

@mroeschke
Copy link
Member

all docstrings seem to have already been added in main, should we close this?

Sure we can close this and have a follow up to improve the docstrings if needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Index Related to the Index class or subclasses
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants