Skip to content

Commit

Permalink
DOC: Enforce Numpy Docstring Validation for pandas.Index.str and pand…
Browse files Browse the repository at this point in the history
…as.Series.str (#58562)

* DOC: add PR01,SA01 for pandas.Index.str and pandas.Series.str

* DOC: remove PR01,SA01 for pandas.Index.str and pandas.Series.str
  • Loading branch information
tuhinsharma121 committed May 5, 2024
1 parent 463eb6e commit ea7bcd1
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
2 changes: 0 additions & 2 deletions ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Index PR07" \
-i "pandas.Index.join PR07,RT03,SA01" \
-i "pandas.Index.ravel PR01,RT03" \
-i "pandas.Index.str PR01,SA01" \
-i "pandas.Interval PR02" \
-i "pandas.IntervalIndex.closed SA01" \
-i "pandas.IntervalIndex.contains RT03" \
Expand Down Expand Up @@ -228,7 +227,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.sparse.sp_values SA01" \
-i "pandas.Series.sparse.to_coo PR07,RT03,SA01" \
-i "pandas.Series.std PR01,RT03,SA01" \
-i "pandas.Series.str PR01,SA01" \
-i "pandas.Series.str.capitalize RT03" \
-i "pandas.Series.str.casefold RT03" \
-i "pandas.Series.str.center RT03,SA01" \
Expand Down
10 changes: 10 additions & 0 deletions pandas/core/strings/accessor.py
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,16 @@ class StringMethods(NoNewAttributesMixin):
Patterned after Python's string methods, with some inspiration from
R's stringr package.
Parameters
----------
data : Series or Index
The content of the Series or Index.
See Also
--------
Series.str : Vectorized string functions for Series.
Index.str : Vectorized string functions for Index.
Examples
--------
>>> s = pd.Series(["A_Str_Series"])
Expand Down

0 comments on commit ea7bcd1

Please sign in to comment.