Skip to content

DOC: Add punctuation to IntervalArray docstrings #28043

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.

Sign up for GitHub

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 1 commit into from
Aug 21, 2019
Merged

DOC: Add punctuation to IntervalArray docstrings #28043

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions pandas/core/arrays/interval.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ def from_arrays(cls, left, right, closed="right", copy=False, dtype=None):
_interval_shared_docs[
"from_tuples"
] = """
Construct an %(klass)s from an array-like of tuples
Construct an %(klass)s from an array-like of tuples.
Parameters
----------
Expand Down Expand Up @@ -854,31 +854,31 @@ def _format_space(self):
def left(self):
"""
Return the left endpoints of each Interval in the IntervalArray as
an Index
an Index.
"""
return self._left

@property
def right(self):
"""
Return the right endpoints of each Interval in the IntervalArray as
an Index
an Index.
"""
return self._right

@property
def closed(self):
"""
Whether the intervals are closed on the left-side, right-side, both or
neither
neither.
"""
return self._closed

_interval_shared_docs[
"set_closed"
] = """
Return an %(klass)s identical to the current one, but closed on the
specified side
specified side.
.. versionadded:: 0.24.0
Expand Down Expand Up @@ -917,7 +917,7 @@ def set_closed(self, closed):
def length(self):
"""
Return an Index with entries denoting the length of each Interval in
the IntervalArray
the IntervalArray.
"""
try:
return self.right - self.left
Expand Down Expand Up @@ -945,7 +945,7 @@ def mid(self):
] = """
Return True if the %(klass)s is non-overlapping (no Intervals share
points) and is either monotonic increasing or monotonic decreasing,
else False
else False.
"""
# https://github.com/python/mypy/issues/1362
# Mypy does not support decorated properties
Expand Down Expand Up @@ -995,7 +995,7 @@ def __array__(self, dtype=None):
_interval_shared_docs[
"to_tuples"
] = """
Return an %(return_type)s of tuples of the form (left, right)
Return an %(return_type)s of tuples of the form (left, right).
Parameters
----------
Expand Down