From fe95f171ac44af6b43c8d6b43961e2f1533233db Mon Sep 17 00:00:00 2001 From: jschendel Date: Fri, 28 Dec 2018 16:16:13 -0700 Subject: [PATCH] DOC: Use top-level pd.IntervalArray in doc examples --- pandas/core/arrays/interval.py | 7 ++----- pandas/core/indexes/interval.py | 2 -- 2 files changed, 2 insertions(+), 7 deletions(-) diff --git a/pandas/core/arrays/interval.py b/pandas/core/arrays/interval.py index 27e89406ec2d6..0e3c59120415d 100644 --- a/pandas/core/arrays/interval.py +++ b/pandas/core/arrays/interval.py @@ -30,10 +30,8 @@ _VALID_CLOSED = {'left', 'right', 'both', 'neither'} _interval_shared_docs = {} -# TODO(jschendel) remove constructor key when IntervalArray is public (GH22860) _shared_docs_kwargs = dict( klass='IntervalArray', - constructor='pd.core.arrays.IntervalArray', name='' ) @@ -105,7 +103,6 @@ """ -# TODO(jschendel) use a more direct call in Examples when made public (GH22860) @Appender(_interval_shared_docs['class'] % dict( klass="IntervalArray", summary="Pandas array for interval data that are closed on the same side.", @@ -119,7 +116,7 @@ A new ``IntervalArray`` can be constructed directly from an array-like of ``Interval`` objects: - >>> pd.core.arrays.IntervalArray([pd.Interval(0, 1), pd.Interval(1, 5)]) + >>> pd.IntervalArray([pd.Interval(0, 1), pd.Interval(1, 5)]) IntervalArray([(0, 1], (1, 5]], closed='right', dtype='interval[int64]') @@ -1035,7 +1032,7 @@ def repeat(self, repeats, axis=None): Examples -------- - >>> intervals = %(constructor)s.from_tuples([(0, 1), (1, 3), (2, 4)]) + >>> intervals = pd.%(klass)s.from_tuples([(0, 1), (1, 3), (2, 4)]) >>> intervals %(klass)s([(0, 1], (1, 3], (2, 4]], closed='right', diff --git a/pandas/core/indexes/interval.py b/pandas/core/indexes/interval.py index 14e73b957d519..c2aca197c55f6 100644 --- a/pandas/core/indexes/interval.py +++ b/pandas/core/indexes/interval.py @@ -36,10 +36,8 @@ _VALID_CLOSED = {'left', 'right', 'both', 'neither'} _index_doc_kwargs = dict(ibase._index_doc_kwargs) -# TODO(jschendel) remove constructor key when IntervalArray is public (GH22860) _index_doc_kwargs.update( dict(klass='IntervalIndex', - constructor='pd.IntervalIndex', target_klass='IntervalIndex or list of Intervals', name=textwrap.dedent("""\ name : object, optional