Skip to content

DOC: Improve docstring for pandas.Index.repeat #19985

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 8 commits into from
Mar 9, 2018
Merged

DOC: Improve docstring for pandas.Index.repeat #19985

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3e33406
Fix docstring
alysivji Mar 4, 2018
1fc4b33
Update location of underlying numpy function
alysivji Mar 4, 2018
5270363
Update with PR comments
alysivji Mar 7, 2018
d4fd529
Simplify docstring
alysivji Mar 7, 2018
9a57c25
Update for change in the docstring guide
jorisvandenbossche Mar 8, 2018
cf4999f
Add kwargs to parameters list
alysivji Mar 9, 2018
4cbaa48
Merge branch 'doc_index-repeat' of github.com:alysivji/pandas into do…
alysivji Mar 9, 2018
8486969
Fix keyword argument parameter in docstring
alysivji Mar 9, 2018
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update location of underlying numpy function
  • Loading branch information
@alysivji
alysivji committed Mar 4, 2018
commit 1fc4b33fab0404ef28fa2790a3523b729eea388d
2 changes: 1 addition & 1 deletion pandas/core/indexes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -709,7 +709,7 @@ def repeat(self, repeats, *args, **kwargs):

See also
Copy link
Member

@datapythonista datapythonista Mar 5, 2018

Choose a reason for hiding this comment

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

If I'm not wrong, "See Also" should have capital "A"
Copy link
Member

@jorisvandenbossche jorisvandenbossche Mar 5, 2018

Choose a reason for hiding this comment

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

Yes, that is correct (although that numpydoc will still recognize it correctly, as it tries to capitalize the words if they are not)
--------
numpy.ndarray.repeat
numpy.repeat
Copy link
Member

@datapythonista datapythonista Mar 5, 2018

Choose a reason for hiding this comment

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

Some information on why numpy.repeat is in the See Also, and differences among them if they exist would be useful.

Also, that's more an open question, but could make sense to list here something like Index.is_unique for example? Probably if we describe better real use-cases, we'll find other related methods.

Examples
--------
Expand Down