Skip to content

Commit f7e098a

Browse files
add docstring index.drop_duplicates
moving away from shared docs and write specific docstring for Index and Series object
1 parent 4131149 commit f7e098a

File tree

1 file changed

+45
-1
lines changed

1 file changed

+45
-1
lines changed

pandas/core/indexes/base.py

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4017,8 +4017,52 @@ def unique(self, level=None):
40174017
result = super(Index, self).unique()
40184018
return self._shallow_copy(result)
40194019

4020-
@Appender(base._shared_docs['drop_duplicates'] % _index_doc_kwargs)
4020+
#@Appender(base._shared_docs['drop_duplicates'] % _index_doc_kwargs)
40214021
def drop_duplicates(self, keep='first'):
4022+
"""
4023+
Return Index with duplicate values removed.
4024+
4025+
The drop_duplicates method can remove occurences or whole sets
4026+
of duplicated entries in a pandas.Index object.
4027+
4028+
Parameters
4029+
----------
4030+
keep : {'first', 'last', False}, default 'first'
4031+
- 'first' : Drop duplicates except for the first occurrence.
4032+
- 'last' : Drop duplicates except for the last occurrence.
4033+
- ``False`` : Drop all duplicates.
4034+
4035+
Returns
4036+
-------
4037+
deduplicated : Index
4038+
4039+
See Also
4040+
--------
4041+
pandas.Series.drop_duplicates : equivalent method on pandas.Series
4042+
4043+
Examples
4044+
--------
4045+
Generate an index with duplicate values.
4046+
>>> idx = pd.Index(['lama', 'cow', 'lama', 'beetle', 'lama', 'hippo'])
4047+
4048+
With the 'keep' parameter, the selection behaviour of duplicated values
4049+
can be changed. The value 'first' keeps the first occurrence for each
4050+
set of duplicated entries. The default value of keep is 'first'.
4051+
4052+
>>> idx.drop_duplicates(keep='first')
4053+
Index(['lama', 'cow', 'beetle', 'hippo'], dtype='object')
4054+
4055+
The value 'last' keeps the last occurrence for each set of duplicated
4056+
entries.
4057+
4058+
>>> idx.drop_duplicates(keep='last')
4059+
Index(['cow', 'beetle', 'lama', 'hippo'], dtype='object')
4060+
4061+
The value ``False`` discards all sets of duplicated entries.
4062+
4063+
>>> idx.drop_duplicates(keep=False)
4064+
Index(['cow', 'beetle', 'hippo'], dtype='object')
4065+
"""
40224066
return super(Index, self).drop_duplicates(keep=keep)
40234067

40244068
@Appender(base._shared_docs['duplicated'] % _index_doc_kwargs)

0 commit comments

Comments
 (0)