Skip to content

Commit 34f8cc9

Browse files
authored
Updated docstrings for missing description
1 parent 85a9a01 commit 34f8cc9

File tree

1 file changed

+45
-45
lines changed

1 file changed

+45
-45
lines changed

pandas/core/arrays/categorical.py

+45-45
Original file line numberDiff line numberDiff line change
@@ -440,12 +440,12 @@ def categories(self):
440440
441441
See Also
442442
--------
443-
rename_categories
444-
reorder_categories
445-
add_categories
446-
remove_categories
447-
remove_unused_categories
448-
set_categories
443+
rename_categories : Rename categories.
444+
reorder_categories : Reorder categories as specified in new_categories.
445+
add_categories : Add new categories.
446+
remove_categories : Remove the specified categories.
447+
remove_unused_categories : Remove categories which are not used.
448+
set_categories : Sets the categories to the specified new_categories.
449449
"""
450450
return self.dtype.categories
451451

@@ -874,11 +874,11 @@ def set_categories(self, new_categories, ordered=None, rename=False, inplace=Fal
874874
875875
See Also
876876
--------
877-
rename_categories
878-
reorder_categories
879-
add_categories
880-
remove_categories
881-
remove_unused_categories
877+
rename_categories : Rename categories.
878+
reorder_categories : Reorder categories as specified in new_categories.
879+
add_categories : Add new categories.
880+
remove_categories : Remove the specified categories.
881+
remove_unused_categories : Remove categories which are not used.
882882
"""
883883
inplace = validate_bool_kwarg(inplace, "inplace")
884884
if ordered is None:
@@ -943,11 +943,11 @@ def rename_categories(self, new_categories, inplace=False):
943943
944944
See Also
945945
--------
946-
reorder_categories
947-
add_categories
948-
remove_categories
949-
remove_unused_categories
950-
set_categories
946+
reorder_categories : Reorder categories as specified in new_categories.
947+
add_categories : Add new categories.
948+
remove_categories : Remove the specified categories.
949+
remove_unused_categories : Remove categories which are not used.
950+
set_categories : Sets the categories to the specified new_categories.
951951
952952
Examples
953953
--------
@@ -1011,11 +1011,11 @@ def reorder_categories(self, new_categories, ordered=None, inplace=False):
10111011
10121012
See Also
10131013
--------
1014-
rename_categories
1015-
add_categories
1016-
remove_categories
1017-
remove_unused_categories
1018-
set_categories
1014+
rename_categories : Rename categories.
1015+
add_categories : Add new categories.
1016+
remove_categories : Remove the specified categories.
1017+
remove_unused_categories : Remove categories which are not used.
1018+
set_categories : Sets the categories to the specified new_categories.
10191019
"""
10201020
inplace = validate_bool_kwarg(inplace, "inplace")
10211021
if set(self.dtype.categories) != set(new_categories):
@@ -1051,11 +1051,11 @@ def add_categories(self, new_categories, inplace=False):
10511051
10521052
See Also
10531053
--------
1054-
rename_categories
1055-
reorder_categories
1056-
remove_categories
1057-
remove_unused_categories
1058-
set_categories
1054+
rename_categories: Rename categories.
1055+
reorder_categories : Reorder categories as specified in new_categories.
1056+
remove_categories : Remove the specified categories.
1057+
remove_unused_categories : Remove categories which are not used.
1058+
set_categories : Sets the categories to the specified new_categories.
10591059
"""
10601060
inplace = validate_bool_kwarg(inplace, "inplace")
10611061
if not is_list_like(new_categories):
@@ -1102,11 +1102,11 @@ def remove_categories(self, removals, inplace=False):
11021102
11031103
See Also
11041104
--------
1105-
rename_categories
1106-
reorder_categories
1107-
add_categories
1108-
remove_unused_categories
1109-
set_categories
1105+
rename_categories : Rename categories.
1106+
reorder_categories : Reorder categories as specified in new_categories.
1107+
add_categories : Add new categories.
1108+
remove_unused_categories : Remove categories which are not used.
1109+
set_categories : Sets the categories to the specified new_categories.
11101110
"""
11111111
inplace = validate_bool_kwarg(inplace, "inplace")
11121112
if not is_list_like(removals):
@@ -1145,11 +1145,11 @@ def remove_unused_categories(self, inplace=False):
11451145
11461146
See Also
11471147
--------
1148-
rename_categories
1149-
reorder_categories
1150-
add_categories
1151-
remove_categories
1152-
set_categories
1148+
rename_categories : Rename categories.
1149+
reorder_categories : Reorder categories as specified in new_categories.
1150+
add_categories : Add new categories.
1151+
remove_categories : Remove the specified categories.
1152+
set_categories : Sets the categories to the specified new_categories.
11531153
"""
11541154
inplace = validate_bool_kwarg(inplace, "inplace")
11551155
cat = self if inplace else self.copy()
@@ -1399,14 +1399,14 @@ def memory_usage(self, deep=False):
13991399
@Substitution(klass="Categorical")
14001400
@Appender(_shared_docs["searchsorted"])
14011401
def searchsorted(self, value, side="left", sorter=None):
1402-
# searchsorted is very performance sensitive. By converting codes
1403-
# to same dtype as self.codes, we get much faster performance.
1404-
if is_scalar(value):
1405-
codes = self.categories.get_loc(value)
1406-
codes = self.codes.dtype.type(codes)
1407-
else:
1408-
locs = [self.categories.get_loc(x) for x in value]
1409-
codes = np.array(locs, dtype=self.codes.dtype)
1402+
from pandas.core.series import Series
1403+
1404+
codes = _get_codes_for_values(Series(value).values, self.categories)
1405+
if -1 in codes:
1406+
raise KeyError("Value(s) to be inserted must be in categories.")
1407+
1408+
codes = codes[0] if is_scalar(value) else codes
1409+
14101410
return self.codes.searchsorted(codes, side=side, sorter=sorter)
14111411

14121412
def isna(self):
@@ -1576,7 +1576,7 @@ def argsort(self, ascending=True, kind="quicksort", *args, **kwargs):
15761576
15771577
See Also
15781578
--------
1579-
numpy.ndarray.argsort
1579+
numpy.ndarray.argsort : Returns the indices that would sort this array.
15801580
15811581
Notes
15821582
-----

0 commit comments

Comments
 (0)