Skip to content

DOC: Fix RangeIndex and other docstrings for missing period in summary #28123

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.

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 27 commits into from
Aug 26, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
d7aabd0
added period to pandas.Categorical.dtype
Aug 21, 2019
a061b49
added period pandas.Categorical.dtype
Aug 24, 2019
976791f
added period pandas.merge_ordered
Aug 24, 2019
19c0a6f
added period pandas.bdate_range
Aug 24, 2019
4ea1ecf
added period pandas.period_range
Aug 24, 2019
58354ec
added period pandas.timedelta_range
Aug 24, 2019
b27f632
added period pandas.interval_range
Aug 24, 2019
4f15661
added period util.hash_pandas_object
Aug 24, 2019
2e19da4
added period pandas.Grouper
Aug 24, 2019
6d32431
added period pandas.Index.memory_usage
Aug 24, 2019
df97818
added period Index.fillna
Aug 24, 2019
e4315d9
added period pandas.Index.dropna
Aug 24, 2019
d010815
added period pandas.RangeIndex.start
Aug 24, 2019
ff4f73f
added period pandas.RangeIndex.stop
Aug 24, 2019
c752272
added period pandas.RangeIndex.step
Aug 24, 2019
fe82f00
Merge branch 'fix-docstrings' of https://github.com/bhuvanakundumani/…
Aug 24, 2019
6cb8630
fixed summary does not have period in pandas.Int64Index
Aug 24, 2019
e2e3bc5
added period at the end pandas.RangeIndex.start
Aug 24, 2019
6ee7be6
added period at the end pandas.RangeIndex.start
Aug 24, 2019
3ff5862
added period ad the end of pandas.RangeIndex.step
Aug 24, 2019
37f52ba
Merge branch 'fix-docstrings' of https://github.com/bhuvanakundumani/…
Aug 24, 2019
9b4cbbf
added period after the bracket pandas.merge_ordered
Aug 24, 2019
bca01f0
restored the spacein pandas.RangeIndex.start
Aug 24, 2019
1cab303
restored the space in pandas.RangeIndex.step
Aug 24, 2019
4bb9f56
restored the space in pandas.merge_ordered
Aug 24, 2019
9a5200d
reverted the change in pandas.Int64Index
Aug 24, 2019
5a765d9
added period to pandas.bdate_range
Aug 24, 2019
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: 1 addition & 1 deletion pandas/core/arrays/categorical.py
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ def ordered(self) -> Ordered:
@property
def dtype(self) -> CategoricalDtype:
"""
The :class:`~pandas.api.types.CategoricalDtype` for this instance
The :class:`~pandas.api.types.CategoricalDtype` for this instance.
"""
return self._dtype

Expand Down
2 changes: 1 addition & 1 deletion pandas/core/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -1462,7 +1462,7 @@ def is_monotonic_decreasing(self):

def memory_usage(self, deep=False):
"""
Memory usage of the values
Memory usage of the values.

Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/groupby/grouper.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
class Grouper:
"""
A Grouper allows the user to specify a groupby instruction for a target
object
object.

This specification will select a column via the key parameter, or if the
level and/or axis parameters are given, a level of the index of the target
Expand Down
4 changes: 2 additions & 2 deletions pandas/core/indexes/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -2020,7 +2020,7 @@ def notna(self):
_index_shared_docs[
"fillna"
] = """
Fill NA/NaN values with the specified value
Fill NA/NaN values with the specified value.

Parameters
----------
Expand Down Expand Up @@ -2051,7 +2051,7 @@ def fillna(self, value=None, downcast=None):
_index_shared_docs[
"dropna"
] = """
Return Index without NA/NaN values
Return Index without NA/NaN values.

Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/indexes/datetimes.py
Original file line number Diff line number Diff line change
Expand Up @@ -1594,7 +1594,7 @@ def bdate_range(
):
"""
Return a fixed frequency DatetimeIndex, with business day as the default
frequency
frequency.

Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/indexes/interval.py
Original file line number Diff line number Diff line change
Expand Up @@ -1310,7 +1310,7 @@ def interval_range(
start=None, end=None, periods=None, freq=None, name=None, closed="right"
):
"""
Return a fixed frequency IntervalIndex
Return a fixed frequency IntervalIndex.

Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/indexes/period.py
Original file line number Diff line number Diff line change
Expand Up @@ -994,7 +994,7 @@ def memory_usage(self, deep=False):
def period_range(start=None, end=None, periods=None, freq=None, name=None):
"""
Return a fixed frequency PeriodIndex, with day (calendar) as the default
frequency
frequency.

Parameters
----------
Expand Down
12 changes: 6 additions & 6 deletions pandas/core/indexes/range.py
Original file line number Diff line number Diff line change
Expand Up @@ -236,15 +236,15 @@ def _format_with_header(self, header, na_rep="NaN", **kwargs):
@cache_readonly
def start(self):
"""
The value of the `start` parameter (``0`` if this was not supplied)
The value of the `start` parameter (``0`` if this was not supplied).
"""
# GH 25710
return self._range.start

@property
def _start(self):
"""
The value of the `start` parameter (``0`` if this was not supplied)
The value of the `start` parameter (``0`` if this was not supplied).

.. deprecated:: 0.25.0
Use ``start`` instead.
Expand All @@ -259,14 +259,14 @@ def _start(self):
@cache_readonly
def stop(self):
"""
The value of the `stop` parameter
The value of the `stop` parameter.
"""
return self._range.stop

@property
def _stop(self):
"""
The value of the `stop` parameter
The value of the `stop` parameter.

.. deprecated:: 0.25.0
Use ``stop`` instead.
Expand All @@ -282,15 +282,15 @@ def _stop(self):
@cache_readonly
def step(self):
"""
The value of the `step` parameter (``1`` if this was not supplied)
The value of the `step` parameter (``1`` if this was not supplied).
"""
# GH 25710
return self._range.step

@property
def _step(self):
"""
The value of the `step` parameter (``1`` if this was not supplied)
The value of the `step` parameter (``1`` if this was not supplied).

.. deprecated:: 0.25.0
Use ``step`` instead.
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/indexes/timedeltas.py
Original file line number Diff line number Diff line change
Expand Up @@ -713,7 +713,7 @@ def timedelta_range(
):
"""
Return a fixed frequency TimedeltaIndex, with day as the default
frequency
frequency.

Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/reshape/merge.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ def merge_ordered(
"""
Perform merge with optional filling/interpolation designed for ordered
data like time series data. Optionally perform group-wise merge (see
examples)
examples).

Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/util/hashing.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def hash_pandas_object(
obj, index=True, encoding="utf8", hash_key=None, categorize=True
):
"""
Return a data hash of the Index/Series/DataFrame
Return a data hash of the Index/Series/DataFrame.

Parameters
----------
Expand Down