DOC: Fix pandas.index.copy summary documentation #32006
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
asepwhite
changed the title
datapythonista
approved these changes
Feb 17, 2020
There was a problem hiding this comment.
lgtm, thanks @asepwhite !
In a follow up you can replace Label by label as the type, and add the description to deep if you want.
| names : list-like, optional | ||
| Kept for compatibility with MultiIndex. Should not be used. | ||
|
|
||
| Returns | ||
| ------- | ||
| Index | ||
| Index refer to new object which is a copy of this object. |
There was a problem hiding this comment.
less verbose here: "New Index object"
| deep : bool, default False | ||
| dtype : numpy dtype or pandas type, optional | ||
| Set dtype for new object. |
There was a problem hiding this comment.
"Set" her and on 835 are unnecessary
|
|
||
| Parameters | ||
| ---------- | ||
| name : Label | ||
| name : Label, optional | ||
| Set name for new object. | ||
| deep : bool, default False | ||
| dtype : numpy dtype or pandas type, optional |
There was a problem hiding this comment.
"pandas type" isnt a thing, possibly "ExtensionDType"? i think strs are also accepted if they can be mapped to dtypes
|
Thanks @asepwhite. If you can please address the review comments in a follow up PR that would be great. |
roberthdevries
pushed a commit
to roberthdevries/pandas
that referenced
this pull request
Mar 2, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diffOutput of
python scripts/validate_docstrings.py pandas.Index.copy################################################################################
######################## Docstring (pandas.Index.copy) ########################
################################################################################
Make a copy of this object.
Name and dtype sets those attributes on the new object.
Parameters
name : Label, optional
Set name for new object.
deep : bool, default False
dtype : numpy dtype or pandas type, optional
Set dtype for new object.
names : list-like, optional
Kept for compatibility with MultiIndex. Should not be used.
Returns
Index
Index refer to new object which is a copy of this object.
Notes
In most cases, there should be no functional difference from using
deep, but ifdeepis passed it will attempt to deepcopy.################################################################################
################################## Validation ##################################
################################################################################
3 Errors found:
Parameter "deep" has no description
See Also section not found
No examples section found