Skip to content

DOC: Styler errors PR08 and PR09 #28656

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

Closed
HughKelley opened this issue Sep 27, 2019 · 2 comments · Fixed by #28743
Closed

DOC: Styler errors PR08 and PR09 #28656

HughKelley opened this issue Sep 27, 2019 · 2 comments · Fixed by #28743

Comments

@HughKelley
Copy link
Contributor

python scripts/validate_docstrings.py pandas.io.formats.style.Styler --errors=PR08,PR09

Problem description

returns:

11 Errors found:
	Parameters {table_attributes} not documented
	Parameter "data" has no description
	Parameter "precision" description should start with a capital letter
	Parameter "precision" description should finish with "."
	Parameter "table_styles" description should start with a capital letter
	Parameter "table_styles" description should finish with "."
	Parameter "uuid" description should start with a capital letter
	Parameter "uuid" description should finish with "."
	Parameter "caption" description should start with a capital letter
	Parameter "caption" description should finish with "."
	Missing description for See Also "DataFrame.style" reference
2 Warnings found:
	No extended summary found
	No examples section found

This is a subset of error messages from #28602 and #25232. Part of the work for #27977

@bhuvanakundumani
Copy link
Contributor

I am interested to work on this .

@HughKelley
Copy link
Contributor Author

Great, go for it. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants