Skip to content

Commit ea7bcd1

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.Index.str and pandas.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
1 parent 463eb6e commit ea7bcd1

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

ci/code_checks.sh

-2
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
8181
-i "pandas.Index PR07" \
8282
-i "pandas.Index.join PR07,RT03,SA01" \
8383
-i "pandas.Index.ravel PR01,RT03" \
84-
-i "pandas.Index.str PR01,SA01" \
8584
-i "pandas.Interval PR02" \
8685
-i "pandas.IntervalIndex.closed SA01" \
8786
-i "pandas.IntervalIndex.contains RT03" \
@@ -228,7 +227,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
228227
-i "pandas.Series.sparse.sp_values SA01" \
229228
-i "pandas.Series.sparse.to_coo PR07,RT03,SA01" \
230229
-i "pandas.Series.std PR01,RT03,SA01" \
231-
-i "pandas.Series.str PR01,SA01" \
232230
-i "pandas.Series.str.capitalize RT03" \
233231
-i "pandas.Series.str.casefold RT03" \
234232
-i "pandas.Series.str.center RT03,SA01" \

pandas/core/strings/accessor.py

+10
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,16 @@ class StringMethods(NoNewAttributesMixin):
162162
Patterned after Python's string methods, with some inspiration from
163163
R's stringr package.
164164
165+
Parameters
166+
----------
167+
data : Series or Index
168+
The content of the Series or Index.
169+
170+
See Also
171+
--------
172+
Series.str : Vectorized string functions for Series.
173+
Index.str : Vectorized string functions for Index.
174+
165175
Examples
166176
--------
167177
>>> s = pd.Series(["A_Str_Series"])

0 commit comments

Comments
 (0)