Skip to content

DOC: don't include all methods/attributes of IntervalIndex #16221

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
May 4, 2017
Merged

DOC: don't include all methods/attributes of IntervalIndex #16221

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2775d9b
DOC: don't include all methods/attributes of IntervalIndex
jorisvandenbossche May 3, 2017
1d46eb4
Change docs for CategoricalIndex and IntervalIndex
TomAugspurger May 4, 2017
4dc57b4
Don't exclude Interval
TomAugspurger May 4, 2017
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
3 changes: 2 additions & 1 deletion doc/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,7 +618,6 @@ strings and apply several methods to it. These can be accessed like
Series.cat
Series.dt
Index.str
CategoricalIndex.str
MultiIndex.str
DatetimeIndex.str
TimedeltaIndex.str
Expand Down Expand Up @@ -1404,6 +1403,7 @@ CategoricalIndex

.. autosummary::
:toctree: generated/
:template: autosummary/class_without_autosummary.rst

CategoricalIndex

Expand Down Expand Up @@ -1432,6 +1432,7 @@ IntervalIndex

.. autosummary::
:toctree: generated/
:template: autosummary/class_without_autosummary.rst

IntervalIndex

Expand Down
5 changes: 4 additions & 1 deletion doc/sphinxext/numpydoc/numpydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,10 @@ def mangle_docstrings(app, what, name, obj, options, lines,
)

# PANDAS HACK (to remove the list of methods/attributes for Categorical)
if what == "class" and name.endswith(".Categorical"):
if what == "class" and (name.endswith(".Categorical") or
name.endswith("CategoricalIndex") or
name.endswith("Interval") or
Copy link
Member Author

Choose a reason for hiding this comment

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

@TomAugspurger I think Interval class itself is OK to have with all its methods / attributes ?

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, right... Is that in the api.rst?

Copy link
Contributor

Choose a reason for hiding this comment

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

Doesn't look like it, but I'll remove it anyway.

name.endswith("IntervalIndex")):
cfg['class_members_list'] = False

if what == 'module':
Expand Down
3 changes: 3 additions & 0 deletions pandas/core/indexes/category.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ class CategoricalIndex(Index, base.PandasDelegate):
name : object
Name to be stored in the index

See Also
--------
Categorical, Index
"""

_typ = 'categoricalindex'
Expand Down
4 changes: 4 additions & 0 deletions pandas/core/indexes/interval.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,10 @@ class IntervalIndex(IntervalMixin, Index):
Name to be stored in the index.
copy : boolean, default False
Copy the meta-data

See Also
--------
Index
"""
_typ = 'intervalindex'
_comparables = ['name']
Expand Down