Skip to content

DOC: Fixes to docstrings formatting #28096

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 13 commits into from
Aug 25, 2019
Merged

Conversation

realjohnward
Copy link
Contributor

  • closes #xxxx
  • tests added / passed
  • passes black pandas
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry

@pep8speaks
Copy link

pep8speaks commented Aug 22, 2019

Hello @realjohnward! 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 2019-08-24 15:09:22 UTC

@realjohnward
Copy link
Contributor Author

@datapythonista Here is the new PR I said I'd make in the PR you requested changes on.

@realjohnward
Copy link
Contributor Author

How do I resolve the failed checks? @datapythonista

@@ -431,8 +431,9 @@ def _is_metadata_of(group, parent_group):
class HDFStore:

Copy link
Member

Choose a reason for hiding this comment

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

can you remove this extra newline

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, thanks for the fixes @realjohnward

I added couple of comments, but also check the logs of the CI to see what's exactly complaining about

@@ -231,18 +230,25 @@ def __add__(date):
- microsecond
- nanosecond

.

Copy link
Member

Choose a reason for hiding this comment

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

Can you remove those?


to be applied to an existing datetime an can replace specific components of

that datetime, or represents an interval of time.
Copy link
Member

Choose a reason for hiding this comment

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

to continue with the description of the see also, avoid the blank lines and indent the continued description

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for getting back to me, just committed the changes you requested.

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 good, nice PR @realjohnward, thanks for working on this.

Feel free to keep working on those errors, we have as much as you can want to fix. :)

@datapythonista datapythonista changed the title Docstrings DOC: Fixes to docstrings formatting Aug 24, 2019
@WillAyd WillAyd added this to the 1.0 milestone Aug 25, 2019
@WillAyd WillAyd merged commit 5d9fd7e into pandas-dev:master Aug 25, 2019
@WillAyd
Copy link
Member

WillAyd commented Aug 25, 2019

Thanks @realjohnward

proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019
proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019
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