Skip to content
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

Docstring validation script: handle args/kwargs #20072

Conversation

jorisvandenbossche
Copy link
Member

This ensures that if you use **kwargs in the docstring Parameters, the validation script does not complain.
But it does not yet check it is actually written like that.

@pep8speaks
Copy link

pep8speaks commented Mar 9, 2018

Hello @jorisvandenbossche! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on March 09, 2018 at 09:28 Hours UTC

@codecov
Copy link

codecov bot commented Mar 9, 2018

Codecov Report

Merging #20072 into master will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #20072      +/-   ##
==========================================
+ Coverage   91.69%   91.72%   +0.02%     
==========================================
  Files         150      150              
  Lines       49112    49112              
==========================================
+ Hits        45035    45047      +12     
+ Misses       4077     4065      -12
Flag Coverage Δ
#multiple 90.1% <ø> (+0.02%) ⬆️
#single 41.86% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/plotting/_converter.py 66.81% <0%> (+1.73%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9119d07...066fd2f. Read the comment docs.

@jreback jreback added the Docs label Mar 9, 2018
@TomAugspurger
Copy link
Contributor

FYI, we use **kwds in some of the plotting docs. I haven't looked, but does that mess things up? We can / should just change those to **kwargs.

@TomAugspurger TomAugspurger added this to the 0.23.0 milestone Mar 9, 2018
@jreback
Copy link
Contributor

jreback commented Mar 10, 2018

lgtm. maybe we could/should run this in our lint.sh script? (or as an additional item in the CI). Gives much more deedback than the doc-build .

@jorisvandenbossche
Copy link
Member Author

Check is included for this in #20061, so closing this

@jorisvandenbossche jorisvandenbossche modified the milestones: 0.23.0, No action Mar 14, 2018
@jorisvandenbossche jorisvandenbossche deleted the validate-docstrings branch March 14, 2018 14:42
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.

4 participants