-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Fix docstrings with the sections in the wrong order #24280
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
Labels
Milestone
Comments
Happy to have a look at this one. |
thanks @benjaminr as it says in the description, make sure you just fixed the ones listed, otherwise you'll get conflicts when we merge #24132 |
2 tasks
benjaminr
added a commit
to benjaminr/pandas
that referenced
this issue
Dec 14, 2018
benjaminr
added a commit
to benjaminr/pandas
that referenced
this issue
Dec 14, 2018
3 tasks
jreback
pushed a commit
that referenced
this issue
Dec 19, 2018
TomAugspurger
pushed a commit
to TomAugspurger/pandas
that referenced
this issue
Dec 20, 2018
benjaminr
added a commit
to benjaminr/pandas
that referenced
this issue
Jan 13, 2019
Pingviinituutti
pushed a commit
to Pingviinituutti/pandas
that referenced
this issue
Feb 28, 2019
Pingviinituutti
pushed a commit
to Pingviinituutti/pandas
that referenced
this issue
Feb 28, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
After #24132 is merged, we'll have few docstrings where the order of the sections is wrong:
We should fix the order of those, and add to
ci/code_checks.py
, in the part wherescripts/validate_docstrings.py
is called, the errorGL07
, so when docstrings are created or modified, the CI validates that all the pandas docstrings still have the right order.The next command can be used to see if all the cases are fixed:
$ ./scripts/validate_docstrings.py --errors=GL07
, but before #24132 is merged, it will also return the cases already fixed in theat PR.The text was updated successfully, but these errors were encountered: