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: Removed duplicate doc line #24668

Closed
wants to merge 1 commit into from
Closed

DOC: Removed duplicate doc line #24668

wants to merge 1 commit into from

Conversation

palewire
Copy link
Contributor

@palewire palewire commented Jan 8, 2019

This line of documentation is already included in the parent shared docs. So the line appears twice. See the screenshot below from the Dataframe.aggregate page. My patch cleans that up.

screenshot from 2019-01-07 17-00-12

@WillAyd
Copy link
Member

WillAyd commented Jan 8, 2019

Looking at the dev docs I think there are actually a few other issues with this one. Do you mind taking a look?

http://pandas-docs.github.io/pandas-docs-travis/api/generated/pandas.DataFrame.aggregate.html?highlight=aggregate#pandas.DataFrame.aggregate

@WillAyd WillAyd added the Docs label Jan 8, 2019
@codecov
Copy link

codecov bot commented Jan 8, 2019

Codecov Report

Merging #24668 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #24668   +/-   ##
=======================================
  Coverage   92.37%   92.37%           
=======================================
  Files         166      166           
  Lines       52315    52315           
=======================================
  Hits        48327    48327           
  Misses       3988     3988
Flag Coverage Δ
#multiple 90.79% <ø> (ø) ⬆️
#single 43.06% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/frame.py 96.92% <ø> (ø) ⬆️

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 be406f3...d4c941b. Read the comment docs.

1 similar comment
@codecov
Copy link

codecov bot commented Jan 8, 2019

Codecov Report

Merging #24668 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #24668   +/-   ##
=======================================
  Coverage   92.37%   92.37%           
=======================================
  Files         166      166           
  Lines       52315    52315           
=======================================
  Hits        48327    48327           
  Misses       3988     3988
Flag Coverage Δ
#multiple 90.79% <ø> (ø) ⬆️
#single 43.06% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/frame.py 96.92% <ø> (ø) ⬆️

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 be406f3...d4c941b. Read the comment docs.

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.

See comment above

@datapythonista
Copy link
Member

@palewire do you mind running ./scripts/validate_docstrings.py pandas.DataFrame.aggregate and copy the full output here in a comment? That will make it easier to review.

I'm not sure your fix is correct, as the latest version is different from your screenshot and the link you referred to. Seems like there is a problem with the sections, and those notes are now rendered in the returns section.

You may also want to run ./doc/make.py html --single=pandas.DataFrame.aggregate to see how your changes will look like.

@rotuna
Copy link

rotuna commented Jan 26, 2019

@WillAyd @palewire @datapythonista

I've tried to fix the issues. The PR is here #24948. Please let me know if anything is amiss.

@jreback
Copy link
Contributor

jreback commented Jan 26, 2019

close this in favor of #24948, a more comprehensive fix.

@jreback jreback closed this Jan 26, 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