Skip to content
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

Jump to bottom

DOC: CategoricalIndex doc string #24852

Merged
merged 5 commits into from
Feb 28, 2019
Merged

DOC: CategoricalIndex doc string #24852

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
178040e
DOC: CategoricalIndex doc string
topper-123 Jan 20, 2019
77de1da
Some fixes to doc string
topper-123 Jan 21, 2019
db97ee2
Some fixes to doc string II
topper-123 Jan 21, 2019
c2be150
fixups
jorisvandenbossche Feb 19, 2019
76970f3
Merge remote-tracking branch 'upstream/master' into topper-123-Catego…
jorisvandenbossche Feb 19, 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
24 changes: 11 additions & 13 deletions pandas/core/indexes/category.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,25 +44,25 @@ class CategoricalIndex(Index, accessor.PandasDelegate):
"""
Index based on an underlying :class:`Categorical`.

`CategoricalIndex`, like `Categorical` can only take on a limited,
CategoricalIndex, like Categorical, can only take on a limited,
and usually fixed, number of possible values (`categories`). Also,
like `Categorical`, it might have an order, but numerical operations
like Categorical, it might have an order, but numerical operations
(additions, divisions, ...) are not possible.

Parameters
----------
data : list-like
The values of the categorical. If categories are given, values not in
categories will be replaced with NaN.
data : array-like (1-dimensional)
The values of the categorical. If `categories` are given, values not in
`categories` will be replaced with NaN.
categories : index-like, optional
The categories for the categorical. Items need to be unique.
If the categories are not given here, then they must be provided
in `dtype`.
If the categories are not given here (and also not in `dtype`), they
will be inferred from the `data`.
ordered : bool, optional
Whether or not this categorical is treated as an ordered
categorical. If not given here or in `dtype`, the resulting
categorical will be unordered.
dtype : CategoricalDtype or the str "category", optional
dtype : CategoricalDtype or the string "category", optional
If :class:`CategoricalDtype`, cannot be used together with
`categories` or `ordered`.

Expand All @@ -77,7 +77,6 @@ class CategoricalIndex(Index, accessor.PandasDelegate):
codes
categories
ordered
dtype

Methods
-------
Expand All @@ -102,13 +101,13 @@ class CategoricalIndex(Index, accessor.PandasDelegate):
See Also
--------
Index : The base pandas Index type.
Categorical : A categorical variable in classic R / S-plus fashion.
Categorical : A categorical array.
CategoricalDtype : Type for categorical data.

Notes
-----
See the `user guide
<https://pandas-docs.github.io/pandas-docs-travis/advanced.html#categoricalindex>`_
<http://pandas.pydata.org/pandas-docs/stable/user_guide/advanced.html#categoricalindex>`_
WillAyd marked this conversation as resolved.
Show resolved Hide resolved
for more.

Examples
Expand All @@ -122,8 +121,7 @@ class CategoricalIndex(Index, accessor.PandasDelegate):
>>> pd.CategoricalIndex(c)
CategoricalIndex(['a', 'b', 'c', 'a', 'b', 'c'], categories=['a', 'b', 'c'], ordered=False, dtype='category') # noqa

Ordered `CategoricalIndex` can be sorted according to the custom order
of the categories and can have a min and max value.
Ordered ``CategoricalIndex`` can have a min and max value.

>>> ci = pd.CategoricalIndex(['a','b','c','a','b','c'], ordered=True,
... categories=['c', 'b', 'a'])
Expand Down