Skip to content

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

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

Merged
merged 1 commit into from
Dec 15, 2017
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3563,6 +3563,44 @@ def head(self, n=5):
-------
obj_head : type of caller
The first n rows of the caller object.

See Also
--------
pandas.DataFrame.tail

Examples
--------
>>> df = pd.DataFrame({'animal':['alligator', 'bee', 'falcon', 'lion',
... 'monkey', 'parrot', 'shark', 'whale', 'zebra']})
>>> df
animal
0 alligator
1 bee
2 falcon
3 lion
4 monkey
5 parrot
6 shark
7 whale
8 zebra

Viewing the first 5 lines

>>> df.head()
animal
0 alligator
1 bee
2 falcon
3 lion
4 monkey

Viewing the first n lines (three in this case)

>>> df.head(3)
animal
0 alligator
1 bee
2 falcon
"""

return self.iloc[:n]
Expand All @@ -3580,6 +3618,44 @@ def tail(self, n=5):
-------
obj_tail : type of caller
The last n rows of the caller object.

See Also
--------
pandas.DataFrame.head

Examples
--------
>>> df = pd.DataFrame({'animal':['alligator', 'bee', 'falcon', 'lion',
... 'monkey', 'parrot', 'shark', 'whale', 'zebra']})
>>> df
animal
0 alligator
1 bee
2 falcon
3 lion
4 monkey
5 parrot
6 shark
7 whale
8 zebra

Viewing the last 5 lines

>>> df.tail()
animal
4 monkey
5 parrot
6 shark
7 whale
8 zebra

Viewing the last n lines (three in this case)

>>> df.tail(3)
animal
6 shark
7 whale
8 zebra
"""

if n == 0:
Expand Down