-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working on this, added some comments, but looks good.
pandas/core/indexes/range.py
Outdated
""" | ||
# 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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same
pandas/core/indexes/range.py
Outdated
@@ -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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same
pandas/core/indexes/range.py
Outdated
""" | ||
# 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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same
@datapythonista - have made the requested changes. Thanks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple of small things, but almost there.
It may be useful to do a code review yourself once you're done, so you know exactly what you're proposing.
Thanks!
pandas/core/indexes/numeric.py
Outdated
@@ -168,7 +168,7 @@ def _union(self, other, sort): | |||
] = """ | |||
Immutable ndarray implementing an ordered, sliceable set. The basic object | |||
storing axis labels for all pandas objects. %(klass)s is a special case | |||
of `Index` with purely %(ltype)s labels. %(extra)s | |||
of `Index` with purely %(ltype)s labels. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you revert this one for now. It's a bit more complex, we'll take care of it in a separate PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
pandas/core/indexes/range.py
Outdated
""" | ||
# 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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same
pandas/core/reshape/merge.py
Outdated
@@ -177,8 +177,8 @@ def merge_ordered( | |||
): | |||
""" | |||
Perform merge with optional filling/interpolation designed for ordered | |||
data like time series data. Optionally perform group-wise merge (see | |||
examples) | |||
data like time series data. Optionally perform group-wise merge(see |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks perfect now, thanks a lot for the fixes @bhuvanakundumani.
Thanks @bhuvanakundumani |
Thanks @datapythonista @WillAyd. |
black pandas
git diff upstream/master -u -- "*.py" | flake8 --diff
@datapythonista
I added the period to the following cases:
pandas.Categorical.dtype: Summary does not end with a period
pandas.merge_ordered: Summary does not end with a period
pandas.bdate_range: Summary does not end with a period
pandas.period_range: Summary does not end with a period
pandas.timedelta_range: Summary does not end with a period
pandas.interval_range: Summary does not end with a period
pandas.util.hash_pandas_object: Summary does not end with a period
pandas.Grouper: Summary does not end with a period
pandas.Index.memory_usage: Summary does not end with a period
pandas.Index.fillna: Summary does not end with a period
pandas.Index.dropna: Summary does not end with a period
pandas.RangeIndex.start: Summary does not end with a period
pandas.RangeIndex.stop: Summary does not end with a period
pandas.RangeIndex.step: Summary does not end with a period