Skip to content

See also description formatting #24561

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 3 commits into from
Jan 4, 2019
Merged

See also description formatting #24561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ecd7a87
DOC: Adjusted formatting of See Also sections resolving issue GH23630
dylanchase Jan 2, 2019
2b6b30b
DOC: Adjusted formatting of See Also sections resolving issue GH23630
dylanchase Jan 2, 2019
f26a56a
Adjuested See Also description
dylanchase Jan 2, 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
4 changes: 2 additions & 2 deletions pandas/_libs/interval.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,8 +389,8 @@ cdef class Interval(IntervalMixin):

See Also
--------
IntervalArray.overlaps : The corresponding method for IntervalArray
IntervalIndex.overlaps : The corresponding method for IntervalIndex
IntervalArray.overlaps : The corresponding method for IntervalArray.
IntervalIndex.overlaps : The corresponding method for IntervalIndex.

Examples
--------
Expand Down
9 changes: 4 additions & 5 deletions pandas/_libs/tslibs/period.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1830,9 +1830,8 @@ cdef class _Period(object):
See Also
--------
Period.dayofweek : Get the day of the week
Period.dayofyear : Get the day of the year
Period.dayofweek : Get the day of the week.
Period.dayofyear : Get the day of the year.
Examples
--------
Expand Down Expand Up @@ -2189,8 +2188,8 @@ cdef class _Period(object):
See Also
--------
Period.days_in_month : Return the days of the month
Period.dayofyear : Return the day of the year
Period.days_in_month : Return the days of the month.
Period.dayofyear : Return the day of the year.
Examples
--------
Expand Down
36 changes: 19 additions & 17 deletions pandas/core/strings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,9 +660,9 @@ def str_match(arr, pat, case=True, flags=0, na=np.nan):

See Also
--------
contains : analogous, but less strict, relying on re.search instead of
re.match
extract : extract matched groups
contains : Analogous, but less strict, relying on re.search instead of
re.match.
extract : Extract matched groups.
"""
if not case:
flags |= re.IGNORECASE
Expand Down Expand Up @@ -1255,13 +1255,13 @@ def str_pad(arr, width, side='left', fillchar=' '):

See Also
--------
Series.str.rjust: Fills the left side of strings with an arbitrary
Series.str.rjust : Fills the left side of strings with an arbitrary
character. Equivalent to ``Series.str.pad(side='left')``.
Series.str.ljust: Fills the right side of strings with an arbitrary
Series.str.ljust : Fills the right side of strings with an arbitrary
character. Equivalent to ``Series.str.pad(side='right')``.
Series.str.center: Fills boths sides of strings with an arbitrary
Series.str.center : Fills boths sides of strings with an arbitrary
character. Equivalent to ``Series.str.pad(side='both')``.
Series.str.zfill: Pad strings in the Series/Index by prepending '0'
Series.str.zfill : Pad strings in the Series/Index by prepending '0'
character. Equivalent to ``Series.str.pad(side='left', fillchar='0')``.

Examples
Expand Down Expand Up @@ -2485,7 +2485,8 @@ def rsplit(self, pat=None, n=-1, expand=False):
'side': 'first',
'return': '3 elements containing the string itself, followed by two '
'empty strings',
'also': 'rpartition : Split the string at the last occurrence of `sep`'
'also': 'rpartition : Split the string at the last occurrence of '
'`sep`.'
})
@deprecate_kwarg(old_arg_name='pat', new_arg_name='sep')
def partition(self, sep=' ', expand=True):
Expand All @@ -2497,7 +2498,8 @@ def partition(self, sep=' ', expand=True):
'side': 'last',
'return': '3 elements containing two empty strings, followed by the '
'string itself',
'also': 'partition : Split the string at the first occurrence of `sep`'
'also': 'partition : Split the string at the first occurrence of '
'`sep`.'
})
@deprecate_kwarg(old_arg_name='pat', new_arg_name='sep')
def rpartition(self, sep=' ', expand=True):
Expand Down Expand Up @@ -2593,13 +2595,13 @@ def zfill(self, width):

See Also
--------
Series.str.rjust: Fills the left side of strings with an arbitrary
Series.str.rjust : Fills the left side of strings with an arbitrary
character.
Series.str.ljust: Fills the right side of strings with an arbitrary
Series.str.ljust : Fills the right side of strings with an arbitrary
character.
Series.str.pad: Fills the specified sides of strings with an arbitrary
Series.str.pad : Fills the specified sides of strings with an arbitrary
character.
Series.str.center: Fills boths sides of strings with an arbitrary
Series.str.center : Fills boths sides of strings with an arbitrary
character.

Notes
Expand Down Expand Up @@ -2793,14 +2795,14 @@ def extractall(self, pat, flags=0):

@Appender(_shared_docs['find'] %
dict(side='lowest', method='find',
also='rfind : Return highest indexes in each strings'))
also='rfind : Return highest indexes in each strings.'))
def find(self, sub, start=0, end=None):
result = str_find(self._parent, sub, start=start, end=end, side='left')
return self._wrap_result(result)

@Appender(_shared_docs['find'] %
dict(side='highest', method='rfind',
also='find : Return lowest indexes in each strings'))
also='find : Return lowest indexes in each strings.'))
def rfind(self, sub, start=0, end=None):
result = str_find(self._parent, sub,
start=start, end=end, side='right')
Expand Down Expand Up @@ -2852,15 +2854,15 @@ def normalize(self, form):

@Appender(_shared_docs['index'] %
dict(side='lowest', similar='find', method='index',
also='rindex : Return highest indexes in each strings'))
also='rindex : Return highest indexes in each strings.'))
def index(self, sub, start=0, end=None):
result = str_index(self._parent, sub,
start=start, end=end, side='left')
return self._wrap_result(result)

@Appender(_shared_docs['index'] %
dict(side='highest', similar='rfind', method='rindex',
also='index : Return lowest indexes in each strings'))
also='index : Return lowest indexes in each strings.'))
def rindex(self, sub, start=0, end=None):
result = str_index(self._parent, sub,
start=start, end=end, side='right')
Expand Down