DOC: Adding example to head and tail method (#16416) #18749

Cheukting · 2017-12-12T21:37:11Z

closes #18691

closes DOC: add examples to docstrings #16416
tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

pep8speaks · 2017-12-12T21:37:14Z

Hello @Cheukting! Thanks for updating the PR.

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

Comment last updated on December 15, 2017 at 13:34 Hours UTC

codecov · 2017-12-12T23:51:47Z

Codecov Report

Merging #18749 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #18749      +/-   ##
==========================================
- Coverage   91.63%   91.62%   -0.02%     
==========================================
  Files         154      154              
  Lines       51422    51422              
==========================================
- Hits        47121    47114       -7     
- Misses       4301     4308       +7

Flag	Coverage Δ
#multiple	`89.48% <ø> (ø)`	⬆️
#single	`40.82% <ø> (-0.12%)`	⬇️

Impacted Files	Coverage Δ
pandas/core/generic.py	`95.9% <ø> (ø)`	⬆️
pandas/io/gbq.py	`25% <0%> (-58.34%)`	⬇️
pandas/core/frame.py	`97.68% <0%> (-0.11%)`	⬇️
pandas/util/testing.py	`82.91% <0%> (+0.19%)`	⬆️

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 fe900cb...e730630. Read the comment docs.

jreback · 2017-12-13T14:07:03Z

can you also add a See Also section to both .head & .tail, this could close #18691

jreback · 2017-12-13T14:32:24Z

looks like this duplicates #18746 and was a little before yours. Happy to have you contribute on any other issues though!

datapythonista · 2017-12-13T15:03:45Z

@jreback, I think this PR is better than #18746. Sorry for the duplicate, they were both implemented in the same sprint, and people was supposed to notify on a gitter channel which methods they were working on, but we failed to do that successfully.

This PR documents both head and tail, and I think the example is a bit clearer. I'd probably use a sorted dataframe for better clarity, and I agree with the "See also" section. Are you ok reopening this PR, and closing the other as duplicate?

@Cheukting, can you add the See also section Jeff mentioned, and sort the dataframe so it's faster for people to see that the first or last rows are the ones returned?

For the See also, in the head you should mention the tail, and viceversa. You have an example of See also section here: https://pandas.pydata.org/pandas-docs/stable/generated/pandas.Series.isin.html

jreback · 2017-12-13T15:10:18Z

yeah happy to have either
will reopen and whomever wants to finish we can take

Cheukting · 2017-12-14T07:42:49Z

@jreback @datapythonista it is all done, let me know if there more changes needed :-)

jreback · 2017-12-15T01:14:25Z

pandas/core/generic.py

+        5  parrot
+        6   shark
+
+        Viewing the last 5 lines (the default)


last -> first

Changes made

jreback · 2017-12-15T01:14:43Z

pandas/core/generic.py

+        3    lion
+        4  monkey
+
+        Viewing the last n lines (three in this case)


same (actually needs editing as well)

By editing you mean?

jreback · 2017-12-15T11:24:32Z

pandas/core/generic.py

+        5  parrot
+        6   shark
+
+        Viewing the first 5 lines (the default)


can you remove '(the default)' and from each of these (e.g. things in '()')

Thanks, changes has been done :-)

datapythonista · 2017-12-15T11:35:01Z

Can I also suggest of having animals starting with A and Z in the list. So it's even more obvious (and faster to see) that the returned rows are the first and the last?

For example:

Alligator
Buffalo
...
Whale
Zebra

I think we can save couple of seconds on understanding the example of each new pandas user that visit these pages. Which given the number of users of pandas, can be a lot of time. :)

jorisvandenbossche

Small comment

jorisvandenbossche · 2017-12-15T12:48:32Z

pandas/core/generic.py

+        8      zebra
+
+        Viewing the first 5 lines
+        >>> df.head()


Can you keep a blank line between the explanation and the code line beginning with >>> ? (and the same for the other occurences)

This might be needed to satisfy sphinx (not fully sure), but I also think it improves readability

Thanks, changes has been done :-)

datapythonista · 2017-12-15T13:17:53Z

pandas/core/generic.py

+
+        Examples
+        --------
+        >>> df = pd.DataFrame({'animal':['falcon', 'parrot', 'lion',


One last typo, this dataframe should also include alligator, bee... it's inconsistent with the results now.

…16416)

jreback · 2017-12-15T23:56:58Z

thanks @Cheukting

Cheukting force-pushed the Documentation branch from aca9e37 to a9f5ad9 Compare December 12, 2017 21:47

Cheukting force-pushed the Documentation branch from 5a9e68e to 2a4f160 Compare December 13, 2017 12:53

jreback added the Output-Formatting __repr__ of pandas objects, to_string label Dec 13, 2017

jreback added this to the 0.22.0 milestone Dec 13, 2017

jreback added the Docs label Dec 13, 2017

jreback mentioned this pull request Dec 13, 2017

Add an ends function that shows both head and tail of the df #18691

Closed

jreback closed this Dec 13, 2017

jreback modified the milestones: 0.22.0, No action Dec 13, 2017

jreback reopened this Dec 13, 2017

Cheukting force-pushed the Documentation branch from d59fba4 to 26911dd Compare December 13, 2017 15:42

jreback requested changes Dec 15, 2017

View reviewed changes

jreback removed this from the No action milestone Dec 15, 2017

Cheukting force-pushed the Documentation branch from 23a449c to 14cc5cf Compare December 15, 2017 10:13

jreback requested changes Dec 15, 2017

View reviewed changes

jreback added this to the 0.22.0 milestone Dec 15, 2017

Cheukting force-pushed the Documentation branch from 9d16f4a to 241a336 Compare December 15, 2017 11:34

Cheukting force-pushed the Documentation branch from 99fdec4 to 018aad7 Compare December 15, 2017 11:47

jorisvandenbossche reviewed Dec 15, 2017

View reviewed changes

Cheukting force-pushed the Documentation branch from 0a982ee to 0abe91c Compare December 15, 2017 12:57

datapythonista reviewed Dec 15, 2017

View reviewed changes

DOC: Adding example and See also to head and tail method (pandas-dev#…

e730630

…16416)

Cheukting force-pushed the Documentation branch from 43feae9 to e730630 Compare December 15, 2017 13:34

jreback approved these changes Dec 15, 2017

View reviewed changes

jreback merged commit c28b624 into pandas-dev:master Dec 15, 2017

jreback mentioned this pull request Dec 15, 2017

Add example to Dataframe.head() method's docstring. #18746

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Adding example to head and tail method (#16416) #18749

DOC: Adding example to head and tail method (#16416) #18749

Cheukting commented Dec 12, 2017 •

edited by jreback

Loading

pep8speaks commented Dec 12, 2017 •

edited

Loading

codecov bot commented Dec 12, 2017 •

edited

Loading

jreback commented Dec 13, 2017

jreback commented Dec 13, 2017

datapythonista commented Dec 13, 2017

jreback commented Dec 13, 2017

Cheukting commented Dec 14, 2017

jreback Dec 15, 2017

Cheukting Dec 15, 2017

jreback Dec 15, 2017

Cheukting Dec 15, 2017

jreback Dec 15, 2017

Cheukting Dec 15, 2017

datapythonista commented Dec 15, 2017

jorisvandenbossche left a comment

jorisvandenbossche Dec 15, 2017

Cheukting Dec 15, 2017

datapythonista Dec 15, 2017

Cheukting Dec 15, 2017

jreback commented Dec 15, 2017

DOC: Adding example to head and tail method (#16416) #18749

DOC: Adding example to head and tail method (#16416) #18749

Conversation

Cheukting commented Dec 12, 2017 • edited by jreback Loading

pep8speaks commented Dec 12, 2017 • edited Loading

Comment last updated on December 15, 2017 at 13:34 Hours UTC

codecov bot commented Dec 12, 2017 • edited Loading

Codecov Report

jreback commented Dec 13, 2017

jreback commented Dec 13, 2017

datapythonista commented Dec 13, 2017

jreback commented Dec 13, 2017

Cheukting commented Dec 14, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

datapythonista commented Dec 15, 2017

jorisvandenbossche left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Dec 15, 2017

Cheukting commented Dec 12, 2017 •

edited by jreback

Loading

pep8speaks commented Dec 12, 2017 •

edited

Loading

codecov bot commented Dec 12, 2017 •

edited

Loading