Skip to content

Commit e5eb7fc

Browse files
bhuvanakundumaniproost
authored andcommitted
DOC: Fix RangeIndex and other docstrings for missing period in summary (pandas-dev#28123)
1 parent 0f9eaec commit e5eb7fc

File tree

11 files changed

+17
-17
lines changed

11 files changed

+17
-17
lines changed

pandas/core/arrays/categorical.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -471,7 +471,7 @@ def ordered(self) -> Ordered:
471471
@property
472472
def dtype(self) -> CategoricalDtype:
473473
"""
474-
The :class:`~pandas.api.types.CategoricalDtype` for this instance
474+
The :class:`~pandas.api.types.CategoricalDtype` for this instance.
475475
"""
476476
return self._dtype
477477

pandas/core/base.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1462,7 +1462,7 @@ def is_monotonic_decreasing(self):
14621462

14631463
def memory_usage(self, deep=False):
14641464
"""
1465-
Memory usage of the values
1465+
Memory usage of the values.
14661466
14671467
Parameters
14681468
----------

pandas/core/groupby/grouper.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
class Grouper:
3838
"""
3939
A Grouper allows the user to specify a groupby instruction for a target
40-
object
40+
object.
4141
4242
This specification will select a column via the key parameter, or if the
4343
level and/or axis parameters are given, a level of the index of the target

pandas/core/indexes/base.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -2020,7 +2020,7 @@ def notna(self):
20202020
_index_shared_docs[
20212021
"fillna"
20222022
] = """
2023-
Fill NA/NaN values with the specified value
2023+
Fill NA/NaN values with the specified value.
20242024
20252025
Parameters
20262026
----------
@@ -2051,7 +2051,7 @@ def fillna(self, value=None, downcast=None):
20512051
_index_shared_docs[
20522052
"dropna"
20532053
] = """
2054-
Return Index without NA/NaN values
2054+
Return Index without NA/NaN values.
20552055
20562056
Parameters
20572057
----------

pandas/core/indexes/datetimes.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1594,7 +1594,7 @@ def bdate_range(
15941594
):
15951595
"""
15961596
Return a fixed frequency DatetimeIndex, with business day as the default
1597-
frequency
1597+
frequency.
15981598
15991599
Parameters
16001600
----------

pandas/core/indexes/interval.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1310,7 +1310,7 @@ def interval_range(
13101310
start=None, end=None, periods=None, freq=None, name=None, closed="right"
13111311
):
13121312
"""
1313-
Return a fixed frequency IntervalIndex
1313+
Return a fixed frequency IntervalIndex.
13141314
13151315
Parameters
13161316
----------

pandas/core/indexes/period.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -994,7 +994,7 @@ def memory_usage(self, deep=False):
994994
def period_range(start=None, end=None, periods=None, freq=None, name=None):
995995
"""
996996
Return a fixed frequency PeriodIndex, with day (calendar) as the default
997-
frequency
997+
frequency.
998998
999999
Parameters
10001000
----------

pandas/core/indexes/range.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -236,15 +236,15 @@ def _format_with_header(self, header, na_rep="NaN", **kwargs):
236236
@cache_readonly
237237
def start(self):
238238
"""
239-
The value of the `start` parameter (``0`` if this was not supplied)
239+
The value of the `start` parameter (``0`` if this was not supplied).
240240
"""
241241
# GH 25710
242242
return self._range.start
243243

244244
@property
245245
def _start(self):
246246
"""
247-
The value of the `start` parameter (``0`` if this was not supplied)
247+
The value of the `start` parameter (``0`` if this was not supplied).
248248
249249
.. deprecated:: 0.25.0
250250
Use ``start`` instead.
@@ -259,14 +259,14 @@ def _start(self):
259259
@cache_readonly
260260
def stop(self):
261261
"""
262-
The value of the `stop` parameter
262+
The value of the `stop` parameter.
263263
"""
264264
return self._range.stop
265265

266266
@property
267267
def _stop(self):
268268
"""
269-
The value of the `stop` parameter
269+
The value of the `stop` parameter.
270270
271271
.. deprecated:: 0.25.0
272272
Use ``stop`` instead.
@@ -282,15 +282,15 @@ def _stop(self):
282282
@cache_readonly
283283
def step(self):
284284
"""
285-
The value of the `step` parameter (``1`` if this was not supplied)
285+
The value of the `step` parameter (``1`` if this was not supplied).
286286
"""
287287
# GH 25710
288288
return self._range.step
289289

290290
@property
291291
def _step(self):
292292
"""
293-
The value of the `step` parameter (``1`` if this was not supplied)
293+
The value of the `step` parameter (``1`` if this was not supplied).
294294
295295
.. deprecated:: 0.25.0
296296
Use ``step`` instead.

pandas/core/indexes/timedeltas.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -713,7 +713,7 @@ def timedelta_range(
713713
):
714714
"""
715715
Return a fixed frequency TimedeltaIndex, with day as the default
716-
frequency
716+
frequency.
717717
718718
Parameters
719719
----------

pandas/core/reshape/merge.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ def merge_ordered(
178178
"""
179179
Perform merge with optional filling/interpolation designed for ordered
180180
data like time series data. Optionally perform group-wise merge (see
181-
examples)
181+
examples).
182182
183183
Parameters
184184
----------

pandas/core/util/hashing.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def hash_pandas_object(
5858
obj, index=True, encoding="utf8", hash_key=None, categorize=True
5959
):
6060
"""
61-
Return a data hash of the Index/Series/DataFrame
61+
Return a data hash of the Index/Series/DataFrame.
6262
6363
Parameters
6464
----------

0 commit comments

Comments
 (0)