Skip to content

DOC: Clean dubious docstring #50484

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Dec 29, 2022
Merged

DOC: Clean dubious docstring #50484

merged 5 commits into from
Dec 29, 2022

Conversation

luke396
Copy link
Contributor

@luke396 luke396 commented Dec 29, 2022

@datapythonista
Copy link
Member

Thanks @luke396 this looks nice. I think in general we don't document __init__ but the class itself. Do you mind moving what's in the __init__ docstring to the class docstring? I think that will be even better and more consistent. Thanks!

@luke396
Copy link
Contributor Author

luke396 commented Dec 29, 2022

Thanks @luke396 this looks nice. I think in general we don't document __init__ but the class itself. Do you mind moving what's in the __init__ docstring to the class docstring? I think that will be even better and more consistent. Thanks!

I change it, what about this time? 😃

datapythonista
datapythonista reviewed Dec 29, 2022
View reviewed changes
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.

Looks great. Just added couple of small things, you can commit them from the github UI

@luke396
Copy link
Contributor Author

luke396 commented Dec 29, 2022

Looks great. Just added couple of small things, you can commit them from the github UI

Thanks for the review!

datapythonista
datapythonista approved these changes Dec 29, 2022
View reviewed changes
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.

lgtm, thanks for fixing this @luke396

@phofl phofl added this to the 2.0 milestone Dec 29, 2022
@phofl phofl merged commit 0720b03 into pandas-dev:main Dec 29, 2022
@phofl
Copy link
Member

phofl commented Dec 29, 2022

thx @luke396

@luke396 luke396 deleted the luke396/issue50344 branch December 30, 2022 03:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@datapythonista datapythonista datapythonista approved these changes

@phofl phofl phofl approved these changes

Assignees
No one assigned
Labels
Clean Docs
Projects
None yet
Milestone
2.0
Development

Successfully merging this pull request may close these issues.

CLEAN dubious docstring
3 participants
@luke396 @datapythonista @phofl