DOC: Fix pandas.Series.str.get RT03,SA01 (pandas-dev#59396)

* DOC: Fix pandas.Series.str.get RT03,SA01 * DOC: remove pandas.Series.str.get from code_checks.sh
tnir · Aug 5, 2024 · 72e3a32 · 72e3a32
1 parent b3215b5
commit 72e3a32
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -166,7 +166,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.Series.str.decode PR07,RT03,SA01" \
         -i "pandas.Series.str.encode PR07,RT03,SA01" \
         -i "pandas.Series.str.fullmatch RT03" \
-        -i "pandas.Series.str.get RT03,SA01" \
         -i "pandas.Series.str.index RT03" \
         -i "pandas.Series.str.ljust RT03,SA01" \
         -i "pandas.Series.str.lower RT03" \

diff --git a/pandas/core/strings/accessor.py b/pandas/core/strings/accessor.py
@@ -1085,6 +1085,13 @@ def get(self, i):
         Returns
         -------
         Series or Index
+            Series or Index where each value is the extracted element from
+            the corresponding input component.
+
+        See Also
+        --------
+        Series.str.extract : Extract capture groups in the regex as columns
+            in a DataFrame.
 
         Examples
         --------