Skip to content

DOC: update the DataFrame.head() docstring #20206

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 3 commits into from
Mar 10, 2018
Merged

DOC: update the DataFrame.head() docstring #20206

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1ff4c6
DOC: Improve the docstring of DataFrame.head()
aterrel Mar 10, 2018
7856ad5
DOC: Improving pandas.DataFrame.head
aterrel Mar 10, 2018
cfd3bcf
DOC: Updating pandas.DataFrame.head - backticks around n
aterrel Mar 10, 2018
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
5 changes: 5 additions & 0 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3607,6 +3607,10 @@ def head(self, n=5):
"""
Return the first n rows.
Copy link
Contributor

@TomAugspurger TomAugspurger Mar 10, 2018

Choose a reason for hiding this comment

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

backticks around n

Copy link
Contributor Author

@aterrel aterrel Mar 10, 2018

Choose a reason for hiding this comment

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

thanks!


This function returns rows for the object based on the underlying
Copy link
Contributor Author

@aterrel aterrel Mar 10, 2018

Choose a reason for hiding this comment

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

is object the right word?

Copy link
Contributor

@joaoavf joaoavf Mar 10, 2018

Choose a reason for hiding this comment

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

Might be good to use 'returns the first n rows' instead of just 'returns rows'.

Copy link
Contributor Author

@aterrel aterrel Mar 10, 2018

Choose a reason for hiding this comment

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

Yup will update.

index. It is useful for quickly testing if your object has the
Copy link
Contributor

@joaoavf joaoavf Mar 10, 2018

Choose a reason for hiding this comment

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

Might be good to put this in a separate paragraph: 'It is useful for quickly testing if your object has the right type of data in it.'

Copy link
Contributor Author

@aterrel aterrel Mar 10, 2018

Choose a reason for hiding this comment

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

Hmm I thought that would be a bit too long.

right type of data in it.

Parameters
----------
n : int, default 5
Expand All @@ -3620,6 +3624,7 @@ def head(self, n=5):
See Also
--------
pandas.DataFrame.tail
Copy link
Contributor

@joaoavf joaoavf Mar 10, 2018

Choose a reason for hiding this comment

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

According to https://python-sprints.github.io/pandas/guide/pandas_docstring.html, the format should be pandas.DataFrame.tail : Returns the last n rows.

Copy link
Contributor Author

@aterrel aterrel Mar 10, 2018

Choose a reason for hiding this comment

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

Thanks for the catch!

Returns the last n rows.

Examples
--------
Expand Down