Skip to content

DOC: update fixing unknown parameters errors (error code PR02) #28567

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 27, 2019

Conversation

tolaa001
Copy link
Contributor

@tolaa001 tolaa001 commented Sep 22, 2019

  • Documentation update fixing some of the methods with a PR-2 error code which involved updating **kwds to **kwargs

  • No tests required

  • The data frame.plot methods now have the docstring arguments updated from **kwds to **kwargs to match the method signature and exclude them from the PR02 errors:

@@ -1148,7 +1148,7 @@ def kde(self, bw_method=None, ind=None, **kwargs):
1000 equally spaced points are used. If `ind` is a NumPy array, the
KDE is evaluated at the points passed. If `ind` is an integer,
`ind` number of equally spaced points are used.
**kwds : optional
**kwargs : optional
Copy link
Member

Choose a reason for hiding this comment

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

should the "optional" part be consistent across all of these?

@gfyoung gfyoung added Docs Code Style Code style, linting, code_checks labels Sep 22, 2019
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 fixing those, lgtm

but if you don't mind removing the optional in this same PR, that would be great (also ok in a follow up)

@tolaa001
Copy link
Contributor Author

Thanks for approving this Marc 😊. I will do this once am reunited with my laptop tomorrow evening.

Also thanks for all your advise at the Iwoca meet up last week.

@WillAyd
Copy link
Member

WillAyd commented Sep 22, 2019

Any reason why we don't change all instances of kwds to kwargs in this PR?

@datapythonista
Copy link
Member

I'm not sure what's wrong with the CI. You'll have to debug scripts/validate_docstring.py. We don't want **kwargs to have a type in the docstring, if the script is failing because of it, it's a bug that needs to be fixed. Feels a bit weird that seems to be failing just for some of the cases.

@tolaa001
Copy link
Contributor Author

@datapythonista can you please providing me with some guidance as I am unsure why the CI build is failing?
I have fixed the reason it was failing yesterday, it was because I had "" before kwargs`

@jorisvandenbossche jorisvandenbossche changed the title Doc string update fixing unknown parameters errors (error code PR02) DOC: update fixing unknown parameters errors (error code PR02) Sep 27, 2019
@jorisvandenbossche jorisvandenbossche added this to the 1.0 milestone Sep 27, 2019
@jorisvandenbossche jorisvandenbossche merged commit 656db16 into pandas-dev:master Sep 27, 2019
@jorisvandenbossche
Copy link
Member

@tolaa001 Thanks a lot for the contribution!

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.

6 participants