Skip to content

Commit 3dbaa4c

Browse files
tuhinsharma121ammar-qazi
authored andcommitted
DOC: fix SA01,ES01 for pandas.RangeIndex.start (pandas-dev#59728)
* DOC: fix SA01,ES01 for pandas.RangeIndex.start * remove superfluous description of RangeIndex
1 parent b30f6ca commit 3dbaa4c

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7575
-i "pandas.Period.ordinal GL08" \
7676
-i "pandas.PeriodDtype.freq SA01" \
7777
-i "pandas.RangeIndex.from_range PR01,SA01" \
78-
-i "pandas.RangeIndex.start SA01" \
7978
-i "pandas.RangeIndex.step SA01" \
8079
-i "pandas.Series.cat.add_categories PR01,PR02" \
8180
-i "pandas.Series.cat.as_ordered PR01" \

pandas/core/indexes/range.py

+10
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,16 @@ def start(self) -> int:
295295
"""
296296
The value of the `start` parameter (``0`` if this was not supplied).
297297
298+
This property returns the starting value of the `RangeIndex`. If the `start`
299+
value is not explicitly provided during the creation of the `RangeIndex`,
300+
it defaults to 0.
301+
302+
See Also
303+
--------
304+
RangeIndex : Immutable index implementing a range-based index.
305+
RangeIndex.stop : Returns the stop value of the `RangeIndex`.
306+
RangeIndex.step : Returns the step value of the `RangeIndex`.
307+
298308
Examples
299309
--------
300310
>>> idx = pd.RangeIndex(5)

0 commit comments

Comments
 (0)