-
-
Notifications
You must be signed in to change notification settings - Fork 18k
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
DOC: Fix quotes position in pandas.core (#24071) #26037
Conversation
@@ -172,7 +172,7 @@ class providing the base-class of operations. | |||
{examples} | |||
""") | |||
|
|||
_pipe_template = """\ | |||
_pipe_template = """ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you build the doc for pipe here to make sure this is OK? Just want to be sure that removing the continuation doesn't impact expected indentation during substitution
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one seems OK.
@@ -1256,7 +1257,9 @@ def groupby_function(name, alias, npfunc, | |||
numeric_only=True, _convert=False, | |||
min_count=-1): | |||
|
|||
_local_template = "Compute %(f)s of group values" | |||
_local_template = """ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar comment here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call, this one is problematic and is leading to reference/groupby.html
having descriptions like "Compute first of group values See Also ——– pandas.Series.groupby pandas.DataFrame.groupby pandas.Panel.groupby" rather than simply "Compute first of group values". I will take a look into this.
Codecov Report
@@ Coverage Diff @@
## master #26037 +/- ##
==========================================
- Coverage 91.84% 91.83% -0.01%
==========================================
Files 175 175
Lines 52517 52517
==========================================
- Hits 48232 48228 -4
- Misses 4285 4289 +4
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #26037 +/- ##
==========================================
- Coverage 91.97% 91.97% -0.01%
==========================================
Files 175 175
Lines 52379 52379
==========================================
- Hits 48178 48174 -4
- Misses 4201 4205 +4
Continue to review full report at Codecov.
|
Can you merge master? |
@WillAyd Updated. Not sure the best way to satisfy the checks_and_doc and get this other docstring validator happy. |
As you can see in the logs the error is that we now have double line breaks in 13 of the docstrings. There is some inconsistency that needs to be addressed across the docstrings. IIRC had less failures when not using the linebreak in the Appender call so maybe easier to do that and fix whatever is incosnstent there |
closing as stale |
git diff upstream/master -u -- "*.py" | flake8 --diff
./scripts/validate_docstrings.py --prefix=pandas.core --errors=GL01,GL02
is now silent.