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

Conversation

bhuvanakundumani
Copy link
Contributor

@bhuvanakundumani bhuvanakundumani commented Aug 24, 2019

  • closes #xxxx
  • tests added / passed
  • passes black pandas
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry

@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

Copy link
Member

@datapythonista datapythonista left a 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.

"""
# 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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

@@ -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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

"""
# 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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

@bhuvanakundumani
Copy link
Contributor Author

@datapythonista - have made the requested changes. Thanks

@bhuvanakundumani bhuvanakundumani changed the title Doc: Fix RangeIndex and other docstrings for missing period in summary DOC: Fix RangeIndex and other docstrings for missing period in summary Aug 24, 2019
Copy link
Member

@datapythonista datapythonista left a 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!

@@ -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.
Copy link
Member

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

"""
# 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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

@@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

Copy link
Member

@datapythonista datapythonista left a 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.

@WillAyd WillAyd added this to the 1.0 milestone Aug 26, 2019
@WillAyd WillAyd merged commit 2c9c422 into pandas-dev:master Aug 26, 2019
@WillAyd
Copy link
Member

WillAyd commented Aug 26, 2019

Thanks @bhuvanakundumani

@bhuvanakundumani
Copy link
Contributor Author

Thanks @datapythonista @WillAyd.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants