-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Improve docstring of Index.delete #32015
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.
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
Changes from 11 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
7218838
Adding Parameters Description in Docstring
andhikayusup ef9ac73
Changing Return Description in Docstring
andhikayusup d86d520
Changing location to a plural form, indicating can be multiple values
andhikayusup 595b00e
Adding parameter description
andhikayusup 764111f
Adding dot to the end of parameter description
andhikayusup 62ae2e8
adding examples
andhikayusup 6d73ad1
adding examples
andhikayusup 1476676
adding function description
andhikayusup 77c3f64
adding See Also section
andhikayusup b55428d
adding dot to See Also section
andhikayusup 06403b4
removing whitespace below docstring
andhikayusup 28cdc7e
removing comments in example
andhikayusup 262d563
adding newline in examples & adding parameter description
andhikayusup a0a9d15
removing trailling whitespace
andhikayusup f01dcf6
changing parameter description
andhikayusup 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
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5135,9 +5135,30 @@ def delete(self, loc): | |
""" | ||
Make new Index with passed location(-s) deleted. | ||
|
||
Use array of integer as loc parameter to delete multiple locations. | ||
|
||
Parameters | ||
---------- | ||
loc : int | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
Location of item(-s) which will be deleted. | ||
|
||
Returns | ||
------- | ||
new_index : Index | ||
Index | ||
New Index with passed location(-s) deleted. | ||
|
||
See Also | ||
-------- | ||
numpy.delete : Delete any rows and column from NumPy array (ndarray). | ||
|
||
Examples | ||
-------- | ||
>>> idx = pd.Index(['a', 'b', 'c']) | ||
>>> idx.delete(1) # Deleting 'b' | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think you can remove the comment, the example is good enough to be clear that we're deleting b |
||
Index(['a', 'c'], dtype='object') | ||
>>> idx = pd.Index(['a', 'b', 'c']) | ||
datapythonista marked this conversation as resolved.
Show resolved
Hide resolved
|
||
>>> idx.delete([0, 2]) | ||
Index(['b'], dtype='object') | ||
""" | ||
return self._shallow_copy(np.delete(self._data, loc)) | ||
|
||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you explain this in the parameter description please