Skip to content

DOC: Improve describe() documentation #41012

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Apr 20, 2021
Merged

DOC: Improve describe() documentation #41012

merged 2 commits into from
Apr 20, 2021

Conversation

bharatr21
Copy link
Contributor

@bharatr21 bharatr21 commented Apr 18, 2021 •
edited
Loading

It feels more verbose, but necessary?

@bharatr21
Copy link
Contributor Author

Test failure seems unrelated

phofl
phofl reviewed Apr 18, 2021
View reviewed changes
doc/source/getting_started/intro_tutorials/01_table_oriented.rst Outdated
@@ -176,7 +176,7 @@ these are by default not taken into account by the :func:`~DataFrame.describe` m

Many pandas operations return a ``DataFrame`` or a ``Series``. The
:func:`~DataFrame.describe` method is an example of a pandas operation returning a
pandas ``Series``.
pandas ``Series`` (one numerical column) or a pandas ``DataFrame`` (many numerical columns).
Copy link
Member

Choose a reason for hiding this comment

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

Do we need the column reference? Meaning is this done elsewhere in the getting started docs?

@phofl
Copy link
Member

phofl commented Apr 18, 2021

Yeah this test is flaky

@mzeitlin11
Copy link
Member

Thanks for looking at this @Bharat123rox. This patch doesn't look to be addressing the issue - the line before already says that different pandas operations might return a Series or DataFrame.

The issue here is that the next line mentions that this is an example of a Series being returned, but a DataFrame is actually being returned from this describe example

@bharatr21
Copy link
Contributor Author

The issue here is that the next line mentions that this is an example of a Series being returned, but a DataFrame is actually being returned from this describe example

So should we just stick to this example and change it to DataFrame because the given describe() operation can still return both right? So what should be done then?

@phofl
Copy link
Member

phofl commented Apr 18, 2021

I would agree with just mentioning DataFrame and Series, e.g. removing the column reference. Do you agree @mzeitlin11?

@bharatr21
Copy link
Contributor Author

I would agree with just mentioning DataFrame and Series, e.g. removing the column reference. Do you agree @mzeitlin11?

Updated, please re-review

@bharatr21 bharatr21 requested a review from phofl April 19, 2021 04:08
@mroeschke mroeschke added the Docs label Apr 20, 2021
@mroeschke mroeschke added this to the 1.3 milestone Apr 20, 2021
@mroeschke mroeschke merged commit ccb90d6 into pandas-dev:master Apr 20, 2021
@mroeschke
Copy link
Member

Thanks @Bharat123rox

yeshsurya pushed a commit to yeshsurya/pandas that referenced this pull request Apr 21, 2021
@bharatr21 @yeshsurya
DOC: Improve describe() documentation (pandas-dev#41012)
8d96556 
* DOC: Improve describe() documentation

* DOC: Remove Column References
JulianWgs pushed a commit to JulianWgs/pandas that referenced this pull request Jul 3, 2021
@bharatr21 @JulianWgs
DOC: Improve describe() documentation (pandas-dev#41012)
dcecb3d 
* DOC: Improve describe() documentation

* DOC: Remove Column References
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mroeschke mroeschke mroeschke approved these changes

@phofl phofl phofl approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
1.3
Development

Successfully merging this pull request may close these issues.

DOC: Improve describe() doc in getting started
4 participants
@bharatr21 @phofl @mzeitlin11 @mroeschke