Skip to content

DOC: Fixed PR08 docstring errors in pandas.DataFrame #28655

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 7 commits into from
Sep 30, 2019
Merged

DOC: Fixed PR08 docstring errors in pandas.DataFrame #28655

merged 7 commits into from
Sep 30, 2019

Conversation

jb8429
Copy link
Contributor

@jb8429 jb8429 commented Sep 27, 2019

This relates to: 27977. I have fixed the doc PR08 formatting issues for:

pandas.DataFrame.insert: Parameter "column" description should start with a capital letter
pandas.DataFrame.apply: Parameter "raw" description should start with a capital letter
pandas.DataFrame.pipe: Parameter "func" description should start with a capital letter
pandas.DataFrame.pipe: Parameter "args" description should start with a capital letter
pandas.DataFrame.pipe: Parameter "kwargs" description should start with a capital letter
pandas.DataFrame.corr: Parameter "method" description should start with a capital letter
pandas.DataFrame.corrwith: Parameter "axis" description should start with a capital letter
pandas.DataFrame.corrwith: Parameter "method" description should start with a capital letter
pandas.DataFrame.drop_duplicates: Parameter "keep" description should start with a capital letter
pandas.DataFrame.duplicated: Parameter "keep" description should start with a capital letter
pandas.DataFrame.idxmax: Parameter "axis" description should start with a capital letter
pandas.DataFrame.idxmin: Parameter "axis" description should start with a capital letter
pandas.DataFrame.unstack: Parameter "fill_value" description should start with a capital letter
pandas.DataFrame.plot: Parameter "kind" description should start with a capital letter
pandas.DataFrame.plot: Parameter "style" description should start with a capital letter
pandas.DataFrame.to_feather: Parameter "fname" description should start with a capital letter
pandas.DataFrame.to_msgpack: Parameter "path" description should start with a capital letter
pandas.DataFrame.to_msgpack: Parameter "append" description should start with a capital letter
pandas.DataFrame.to_msgpack: Parameter "compress" description should start with a capital letter
pandas.DataFrame.to_clipboard: Parameter "excel" description should start with a capital letter
  • tests added / passed
  • passes black pandas
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff

Will continue to work through all PR08 docstring errors.

@pep8speaks
Copy link

pep8speaks commented Sep 27, 2019

Hello @jackbicknell14! 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-09-29 08:39:19 UTC

@gfyoung gfyoung added the Docs label Sep 28, 2019
@gfyoung gfyoung added the Code Style Code style, linting, code_checks label Sep 28, 2019
@gfyoung
Copy link
Member

gfyoung commented Sep 29, 2019

So close! If you can fix the merge conflict.

this is merge from master fork remotthis is merge from master fork remotee

�
the commit.
@jb8429
Copy link
Contributor Author

jb8429 commented Sep 30, 2019

So close! If you can fix the merge conflict.

Thanks for the help @gfyoung

Have updated and resolved the merge conflict. Please could you also check out my other PR for similar doc issues in PR28571? I think that one is all good to go.

Thanks!

@WillAyd WillAyd added this to the 1.0 milestone Sep 30, 2019
@WillAyd WillAyd merged commit ad3280e into pandas-dev:master Sep 30, 2019
@WillAyd
Copy link
Member

WillAyd commented Sep 30, 2019

Thanks @jackbicknell14 !

@jb8429 jb8429 deleted the docs-pr08-dataframe branch October 1, 2019 18:51
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
bongolegend pushed a commit to bongolegend/pandas that referenced this pull request Jan 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Code Style Code style, linting, code_checks Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants