Skip to content

Commit d11ed2f

Browse files
DOC: fix SA01,ES01 for pandas.arrays.IntervalArray.left (#60168)
1 parent a3f14bf commit d11ed2f

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
8989
-i "pandas.api.types.pandas_dtype PR07,RT03,SA01" \
9090
-i "pandas.arrays.ArrowExtensionArray PR07,SA01" \
9191
-i "pandas.arrays.IntegerArray SA01" \
92-
-i "pandas.arrays.IntervalArray.left SA01" \
9392
-i "pandas.arrays.IntervalArray.length SA01" \
9493
-i "pandas.arrays.IntervalArray.right SA01" \
9594
-i "pandas.arrays.NumpyExtensionArray SA01" \

pandas/core/arrays/interval.py

+16
Original file line numberDiff line numberDiff line change
@@ -1233,6 +1233,22 @@ def left(self) -> Index:
12331233
"""
12341234
Return the left endpoints of each Interval in the IntervalArray as an Index.
12351235
1236+
This property provides access to the left endpoints of the intervals
1237+
contained within the IntervalArray. This can be useful for analyses where
1238+
the starting point of each interval is of interest, such as in histogram
1239+
creation, data aggregation, or any scenario requiring the identification
1240+
of the beginning of defined ranges. This property returns a ``pandas.Index``
1241+
object containing the midpoint for each interval.
1242+
1243+
See Also
1244+
--------
1245+
arrays.IntervalArray.right : Return the right endpoints of each Interval in
1246+
the IntervalArray as an Index.
1247+
arrays.IntervalArray.mid : Return the midpoint of each Interval in the
1248+
IntervalArray as an Index.
1249+
arrays.IntervalArray.contains : Check elementwise if the Intervals contain
1250+
the value.
1251+
12361252
Examples
12371253
--------
12381254

0 commit comments

Comments
 (0)