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

DOC: Fix quotes position in pandas.core (#24071) #26037

Closed
wants to merge 3 commits into from

Conversation

alexcwatt
Copy link
Contributor

./scripts/validate_docstrings.py --prefix=pandas.core --errors=GL01,GL02 is now silent.

@@ -172,7 +172,7 @@ class providing the base-class of operations.
{examples}
""")

_pipe_template = """\
_pipe_template = """
Copy link
Member

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

Copy link
Contributor Author

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 = """
Copy link
Member

Choose a reason for hiding this comment

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

Similar comment here

Copy link
Contributor Author

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.

@WillAyd WillAyd added the Docs label Apr 10, 2019
@codecov
Copy link

codecov bot commented Apr 10, 2019

Codecov Report

Merging #26037 into master will decrease coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            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
Flag Coverage Δ
#multiple 90.39% <100%> (ø) ⬆️
#single 40.72% <100%> (-0.14%) ⬇️
Impacted Files Coverage Δ
pandas/core/groupby/generic.py 87.08% <ø> (ø) ⬆️
pandas/core/groupby/groupby.py 97.21% <100%> (ø) ⬆️
pandas/io/gbq.py 75% <0%> (-12.5%) ⬇️
pandas/core/frame.py 96.79% <0%> (-0.12%) ⬇️

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 9d66bdf...9cb8129. Read the comment docs.

@codecov
Copy link

codecov bot commented Apr 10, 2019

Codecov Report

Merging #26037 into master will decrease coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            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
Flag Coverage Δ
#multiple 90.52% <100%> (ø) ⬆️
#single 40.7% <100%> (-0.15%) ⬇️
Impacted Files Coverage Δ
pandas/core/groupby/generic.py 89.02% <ø> (ø) ⬆️
pandas/core/groupby/groupby.py 97.23% <100%> (ø) ⬆️
pandas/io/gbq.py 78.94% <0%> (-10.53%) ⬇️
pandas/core/frame.py 96.9% <0%> (-0.12%) ⬇️

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 64104ec...d989fa9. Read the comment docs.

@WillAyd
Copy link
Member

WillAyd commented Apr 26, 2019

Can you merge master?

@alexcwatt
Copy link
Contributor Author

@WillAyd Updated. Not sure the best way to satisfy the checks_and_doc and get this other docstring validator happy.

@WillAyd
Copy link
Member

WillAyd commented Apr 29, 2019

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

@jreback
Copy link
Contributor

jreback commented May 12, 2019

closing as stale

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: Fix quotes position in pandas.core
3 participants