pandas.CategoricalIndex.as_ordered

CategoricalIndex.as_ordered(*args, **kwargs)[source]

Set the Categorical to be ordered.

Parameters
inplacebool, default False

Whether or not to set the ordered attribute in-place or return a copy of this categorical with ordered set to True.

Deprecated since version 1.5.0.

Returns
Categorical or None

Ordered Categorical or None if inplace=True.