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 issues with DataFrame.aggregate page #24948

Closed
wants to merge 5 commits into from

Conversation

rotuna
Copy link

@rotuna rotuna commented Jan 26, 2019

Fixed some formatting issues. Description was gettign rendered in the
wrong location.

Moved a line from generic.py to frame.py to help with the rendering.
Moved the description being clubbed with see also to doc string with the
function declaration in frame.py

Fixed some formatting issues. Description was gettign rendered in the
wrong location.

Moved a line from generic.py to frame.py to help with the rendering.
Moved the description being clubbed with see also to doc string with the
function declaration in frame.py
@pep8speaks
Copy link

pep8speaks commented Jan 26, 2019

Hello @rotuna! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on January 27, 2019 at 04:48 Hours UTC

@codecov
Copy link

codecov bot commented Jan 26, 2019

Codecov Report

Merging #24948 into master will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #24948      +/-   ##
==========================================
+ Coverage   91.73%   91.73%   +<.01%     
==========================================
  Files         173      173              
  Lines       52838    52839       +1     
==========================================
+ Hits        48471    48473       +2     
+ Misses       4367     4366       -1
Flag Coverage Δ
#multiple 90.29% <100%> (ø) ⬆️
#single 41.71% <100%> (-0.01%) ⬇️
Impacted Files Coverage Δ
pandas/core/generic.py 94.16% <ø> (ø) ⬆️
pandas/core/groupby/generic.py 86.98% <100%> (ø) ⬆️
pandas/core/series.py 93.7% <100%> (ø) ⬆️
pandas/core/window.py 96.4% <100%> (ø) ⬆️
pandas/core/resample.py 97.22% <100%> (ø) ⬆️
pandas/core/frame.py 96.87% <100%> (ø) ⬆️
pandas/util/testing.py 87.66% <0%> (+0.09%) ⬆️

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 9561b96...ecb2e45. Read the comment docs.

@codecov
Copy link

codecov bot commented Jan 26, 2019

Codecov Report

Merging #24948 into master will decrease coverage by 49.47%.
The diff coverage is 100%.

Impacted file tree graph

@@             Coverage Diff             @@
##           master   #24948       +/-   ##
===========================================
- Coverage   92.37%    42.9%   -49.48%     
===========================================
  Files         166      166               
  Lines       52388    52388               
===========================================
- Hits        48396    22475    -25921     
- Misses       3992    29913    +25921
Flag Coverage Δ
#multiple ?
#single 42.9% <100%> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/generic.py 39.86% <ø> (-56.77%) ⬇️
pandas/core/frame.py 35.84% <100%> (-61.08%) ⬇️
pandas/io/formats/latex.py 0% <0%> (-100%) ⬇️
pandas/core/categorical.py 0% <0%> (-100%) ⬇️
pandas/io/sas/sas_constants.py 0% <0%> (-100%) ⬇️
pandas/tseries/plotting.py 0% <0%> (-100%) ⬇️
pandas/tseries/converter.py 0% <0%> (-100%) ⬇️
pandas/io/formats/html.py 0% <0%> (-99.35%) ⬇️
pandas/core/groupby/categorical.py 0% <0%> (-95.46%) ⬇️
pandas/io/sas/sas7bdat.py 0% <0%> (-91.17%) ⬇️
... and 125 more

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 2626215...9fc48fa. Read the comment docs.

@jreback jreback added the Docs label Jan 26, 2019
pandas/core/generic.py Outdated Show resolved Hide resolved
The summary intended for DataFrame.aggregate was not rendered properly.
Added a summary variable in the aggregate template in generic.py.
Added an empty summary in all pages using the shared doc.
@WillAyd
Copy link
Member

WillAyd commented Jan 29, 2019

@rotuna any chance you could post the output of scripts/validate_docstrings.py for the items you are changing? Would be helpful to see how these ultimately render

@rotuna
Copy link
Author

rotuna commented Jan 29, 2019

Sure

@rotuna
Copy link
Author

rotuna commented Jan 30, 2019

Hi,

@WillAyd

I've attached the output for all the aggregate pages. I can attach the rendered HTML too if you want.

The zip of the output files is here:
Archive.zip

Rendered HTML files are here:
html.zip

@rotuna
Copy link
Author

rotuna commented Feb 8, 2019

@WillAyd Do I need to make any further changes?

@WillAyd WillAyd added this to the 0.25.0 milestone Feb 8, 2019
@WillAyd
Copy link
Member

WillAyd commented Feb 8, 2019

Sorry missed previous ping - can you merge master and resolve conflicts? Will take a look after that

@WillAyd
Copy link
Member

WillAyd commented Feb 19, 2019

@rotuna can you merge master?

Copy link
Member

@WillAyd WillAyd left a comment

Choose a reason for hiding this comment

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

Some comments. Can merge master again to resolve CI issues.

As far as output can you just post the results of the validation of each of these directly in comment rather than zip archive? Will make review easier

If DataFrame.agg is called with several functions, returns a DataFrame
If Series.agg is called with single function, returns a scalar
If Series.agg is called with several functions, returns a Series.
- If DataFrame.agg is called with a single function, returns a Series
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 use asterisks here instead?

Copy link
Member

Choose a reason for hiding this comment

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

Also I think this will fail once #25132 gets merged. Give that a look to see how to handle

@TomAugspurger
Copy link
Contributor

@rotuna looks like there's a merge conflict. Can you merge master & push the update?

@WillAyd
Copy link
Member

WillAyd commented Mar 19, 2019

@rotuna can you merge master and resolve the conflict here?

@WillAyd
Copy link
Member

WillAyd commented Mar 28, 2019

Closing as stale. Ping if you'd like to pick this back up

@WillAyd WillAyd closed this Mar 28, 2019
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.

5 participants