Skip to content

Commit 40b3b64

Browse files
DeaMariaLeontopper-123
authored andcommitted
DOC: Fixing EX01 - Added examples (pandas-dev#53502)
Added examples
1 parent 3956fa4 commit 40b3b64

File tree

3 files changed

+60
-6
lines changed

3 files changed

+60
-6
lines changed

ci/code_checks.sh

-6
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,8 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
8282
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01 --ignore_functions \
8383
pandas.Series.backfill \
8484
pandas.Series.pad \
85-
pandas.Series.str.normalize \
86-
pandas.Series.str.rfind \
87-
pandas.Series.str.rindex \
88-
pandas.Series.str.translate \
8985
pandas.Series.sparse \
9086
pandas.DataFrame.sparse \
91-
pandas.Series.cat.categories \
92-
pandas.Series.cat.ordered \
9387
pandas.Series.cat.codes \
9488
pandas.Series.cat.reorder_categories \
9589
pandas.Series.cat.set_categories \

pandas/core/arrays/categorical.py

+22
Original file line numberDiff line numberDiff line change
@@ -748,13 +748,35 @@ def categories(self) -> Index:
748748
remove_categories : Remove the specified categories.
749749
remove_unused_categories : Remove categories which are not used.
750750
set_categories : Set the categories to the specified ones.
751+
752+
Examples
753+
--------
754+
>>> ser = pd.Series(["a", "b", "c", "a"], dtype="category")
755+
>>> ser.cat.categories
756+
Index(['a', 'b', 'c'], dtype='object')
757+
758+
>>> raw_cat = pd.Categorical(["a", "b", "c", "a"], categories=["b", "c", "d"],)
759+
>>> ser = pd.Series(raw_cat)
760+
>>> ser.cat.categories
761+
Index(['b', 'c', 'd'], dtype='object')
751762
"""
752763
return self.dtype.categories
753764

754765
@property
755766
def ordered(self) -> Ordered:
756767
"""
757768
Whether the categories have an ordered relationship.
769+
770+
Examples
771+
--------
772+
>>> ser = pd.Series(["a", "b", "c", "a"], dtype="category")
773+
>>> ser.cat.ordered
774+
False
775+
776+
>>> raw_cat = pd.Categorical(["a", "b", "c", "a"], ordered=True)
777+
>>> ser = pd.Series(raw_cat)
778+
>>> ser.cat.ordered
779+
True
758780
"""
759781
return self.dtype.ordered
760782

pandas/core/strings/accessor.py

+38
Original file line numberDiff line numberDiff line change
@@ -2261,6 +2261,15 @@ def translate(self, table):
22612261
Returns
22622262
-------
22632263
Series or Index
2264+
2265+
Examples
2266+
--------
2267+
>>> ser = pd.Series(["El niño", "Françoise"])
2268+
>>> mytable = str.maketrans({'ñ': 'n', 'ç': 'c'})
2269+
>>> ser.str.translate(mytable)
2270+
0 El nino
2271+
1 Francoise
2272+
dtype: object
22642273
"""
22652274
result = self._data.array._str_translate(table)
22662275
return self._wrap_result(result)
@@ -2800,12 +2809,23 @@ def extractall(self, pat, flags: int = 0) -> DataFrame:
28002809
28012810
Examples
28022811
--------
2812+
For Series.str.find:
2813+
28032814
>>> ser = pd.Series(["cow_", "duck_", "do_ve"])
28042815
>>> ser.str.find("_")
28052816
0 3
28062817
1 4
28072818
2 2
28082819
dtype: int64
2820+
2821+
For Series.str.rfind:
2822+
2823+
>>> ser = pd.Series(["_cow_", "duck_", "do_v_e"])
2824+
>>> ser.str.rfind("_")
2825+
0 4
2826+
1 4
2827+
2 4
2828+
dtype: int64
28092829
"""
28102830

28112831
@Appender(
@@ -2858,6 +2878,13 @@ def normalize(self, form):
28582878
Returns
28592879
-------
28602880
Series/Index of objects
2881+
2882+
Examples
2883+
--------
2884+
>>> ser = pd.Series(['ñ'])
2885+
>>> ser.str.normalize('NFC') == ser.str.normalize('NFD')
2886+
0 False
2887+
dtype: bool
28612888
"""
28622889
result = self._data.array._str_normalize(form)
28632890
return self._wrap_result(result)
@@ -2892,12 +2919,23 @@ def normalize(self, form):
28922919
28932920
Examples
28942921
--------
2922+
For Series.str.index:
2923+
28952924
>>> ser = pd.Series(["horse", "eagle", "donkey"])
28962925
>>> ser.str.index("e")
28972926
0 4
28982927
1 0
28992928
2 4
29002929
dtype: int64
2930+
2931+
For Series.str.rindex:
2932+
2933+
>>> ser = pd.Series(["Deer", "eagle", "Sheep"])
2934+
>>> ser.str.rindex("e")
2935+
0 2
2936+
1 4
2937+
2 3
2938+
dtype: int64
29012939
"""
29022940

29032941
@Appender(

0 commit comments

Comments
 (0)