From 02f075d394d29ac1f265f8cc25aa97a4c4b55f4a Mon Sep 17 00:00:00 2001 From: drollolo Date: Sun, 29 Mar 2020 15:27:32 +0300 Subject: [PATCH] DOC: Partial fix SA04 errors in docstrings #28792 --- pandas/core/frame.py | 3 ++- pandas/core/indexes/base.py | 10 +++++++--- pandas/core/indexes/datetimes.py | 9 ++++++--- 3 files changed, 15 insertions(+), 7 deletions(-) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 8deeb415c17c9..1aa1db52daa58 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -839,7 +839,8 @@ def style(self) -> "Styler": See Also -------- - io.formats.style.Styler + io.formats.style.Styler : Helps style a DataFrame or Series according to the + data with HTML and CSS. """ from pandas.io.formats.style import Styler diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 83064fe22eaff..d1e2e580ad6b0 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -203,10 +203,14 @@ class Index(IndexOpsMixin, PandasObject): -------- RangeIndex : Index implementing a monotonic integer range. CategoricalIndex : Index of :class:`Categorical` s. - MultiIndex : A multi-level, or hierarchical, Index. + MultiIndex : A multi-level, or hierarchical Index. IntervalIndex : An Index of :class:`Interval` s. - DatetimeIndex, TimedeltaIndex, PeriodIndex - Int64Index, UInt64Index, Float64Index + DatetimeIndex : Index of datetime64 data. + TimedeltaIndex : Index of timedelta64 data. + PeriodIndex : Index of Period data. + Int64Index : A special case of :class:`Index` with purely integer labels. + UInt64Index : A special case of :class:`Index` with purely unsigned integer labels. + Float64Index : A special case of :class:`Index` with purely float labels. Notes ----- diff --git a/pandas/core/indexes/datetimes.py b/pandas/core/indexes/datetimes.py index ca1995adc1ea9..b07616b5befe9 100644 --- a/pandas/core/indexes/datetimes.py +++ b/pandas/core/indexes/datetimes.py @@ -720,7 +720,7 @@ def inferred_type(self) -> str: def indexer_at_time(self, time, asof=False): """ - Return index locations of index values at particular time of day + Return index locations of values at particular time of day (e.g. 9:30AM). Parameters @@ -736,7 +736,9 @@ def indexer_at_time(self, time, asof=False): See Also -------- - indexer_between_time, DataFrame.at_time + indexer_between_time : Get index locations of values between particular + times of day. + DataFrame.at_time : Select values at particular time of day. """ if asof: raise NotImplementedError("'asof' argument is not supported") @@ -777,7 +779,8 @@ def indexer_between_time( See Also -------- - indexer_at_time, DataFrame.between_time + indexer_at_time : Get index locations of values at particular time of day. + DataFrame.between_time : Select values between particular times of day. """ start_time = tools.to_time(start_time) end_time = tools.to_time(end_time)