Skip to content

Commit 2899207

Browse files
committed
DOCS: fix docstring validation errors for pandas.Series pandas-dev#59595
1 parent 3a45265 commit 2899207

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
104104
-i "pandas.Series.dt.tz_localize PR01,PR02" \
105105
-i "pandas.Series.dt.unit GL08" \
106106
-i "pandas.Series.pad PR01,SA01" \
107-
-i "pandas.Series.sparse.fill_value SA01" \
108107
-i "pandas.Series.sparse.from_coo PR07,SA01" \
109108
-i "pandas.Series.sparse.npoints SA01" \
110109
-i "pandas.Series.sparse.sp_values SA01" \

pandas/core/arrays/sparse/array.py

+6
Original file line numberDiff line numberDiff line change
@@ -623,6 +623,12 @@ def fill_value(self):
623623
624624
For memory savings, this should be the most common value in the array.
625625
626+
See Also
627+
--------
628+
Series.sparse : Accessor for handling sparse data.
629+
Series.sparse.npoints : The number of non- ``fill_value`` points.
630+
Series.sparse.sp_values : An ndarray containing the non- ``fill_value`` values.
631+
626632
Examples
627633
--------
628634
>>> ser = pd.Series([0, 0, 2, 2, 2], dtype="Sparse[int]")

pandas/core/strings/accessor.py

+8
Original file line numberDiff line numberDiff line change
@@ -1363,6 +1363,14 @@ def match(self, pat: str, case: bool = True, flags: int = 0, na=None):
13631363
"""
13641364
Determine if each string starts with a match of a regular expression.
13651365
1366+
This method checks if the start of each string in the Series or
1367+
Index matches the specified regular expression (Regex) pattern,
1368+
allowing for complex string matching rules.
1369+
1370+
Additionally, case sensitivity can be specified, Regex module flags can
1371+
be used to modify matching behavior, and a fill value for missing values
1372+
can be provided.
1373+
13661374
Parameters
13671375
----------
13681376
pat : str

0 commit comments

Comments
 (0)