Skip to content

DOC: Styler errors PR08 and PR09 #28743

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

Conversation

bhuvanakundumani
Copy link
Contributor

./scripts/validate_docstrings.py pandas.io.formats.style.Styler --errors=PR08,PR09
  • passes black pandas
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry - not needed

bhuvanakundumani and others added 5 commits August 24, 2019 06:37
Merge branch 'master' of https://github.com/pandas-dev/pandas

 Please enter a commit message to explain why this merge is necessary,
Merge remote-tracking branch 'upstream/master'
@bhuvanakundumani bhuvanakundumani changed the title Errors styler DOC: Styler errors PR08 and PR09 #28656 Oct 2, 2019
@bhuvanakundumani bhuvanakundumani changed the title DOC: Styler errors PR08 and PR09 #28656 DOC: Styler errors PR08 and PR09 Oct 2, 2019
@@ -77,6 +81,8 @@ class Styler:
See Also
--------
DataFrame.style
Returns a Styler object containing methods for building
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this belongs in the See Also section - is this addressing some issue?

Copy link
Contributor Author

@bhuvanakundumani bhuvanakundumani Oct 2, 2019

Choose a reason for hiding this comment

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

Had this error - 'Missing description for See Also "DataFrame.style" reference'. Hence added this line of description

Copy link
Member

Choose a reason for hiding this comment

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

Oh OK thanks for clarifying. I think this is an issue with the validator as the format should match what you see in the docsring guide (specifically small description separated by a colon):

https://python-sprints.github.io/pandas/guide/pandas_docstring.html#section-5-see-also

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Made the changes as requested.

@WillAyd WillAyd added the Docs label Oct 2, 2019
@WillAyd WillAyd added this to the 1.0 milestone Oct 2, 2019
@jorisvandenbossche
Copy link
Member

@bhuvanakundumani Thanks a lot !

@jorisvandenbossche jorisvandenbossche merged commit c0cafbb into pandas-dev:master Oct 2, 2019
@bhuvanakundumani bhuvanakundumani deleted the errors-styler branch October 2, 2019 06:34
@bhuvanakundumani
Copy link
Contributor Author

@bhuvanakundumani Thanks a lot !

Thanks @jorisvandenbossche .

@xaviripper0345
Copy link

Thanks

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Styler errors PR08 and PR09
4 participants