Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.Index.str and pandas.Series.str #58562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 5, 2024
Merged

DOC: Enforce Numpy Docstring Validation for pandas.Index.str and pandas.Series.str #58562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0bab5c4
DOC: add PR01,SA01 for pandas.Index.str and pandas.Series.str
tuhinsharma121 May 4, 2024
51a45f9
DOC: remove PR01,SA01 for pandas.Index.str and pandas.Series.str
tuhinsharma121 May 4, 2024
17916f0
Merge branch 'main' into np-doc-index-str
tuhinsharma121 May 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,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 @@ -232,7 +231,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
View file
Open in desktop
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