DOC: Fix Pandas.series.str.fullmatch RT03 (pandas-dev#59395)

* DOC: fix andas.Series.str.fullmatch RT03 * DOC: remove pandas.Series.str.fullmatch RT03 from code_checks.sh
tnir · Aug 6, 2024 · dfbd97e · dfbd97e
1 parent 70bb855
commit dfbd97e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -164,7 +164,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.Series.str.center RT03,SA01" \
         -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.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
@@ -1418,6 +1418,9 @@ def fullmatch(self, pat, case: bool = True, flags: int = 0, na=None):
         Returns
         -------
         Series/Index/array of boolean values
+            The function returns a Series, Index, or array of boolean values,
+            where True indicates that the entire string matches the regular
+            expression pattern and False indicates that it does not.
 
         See Also
         --------