-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: update api.rst for Categorical accessors / methods #15957
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.
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
Comments
I pushed a tiny update: b4c6fc1 but I think should create a separate sub-section for this |
I think this absence was rather intentional. Because people should actually mostly use categorical Series, we didn't want to give too much attention to plain Categorical in the docs? Quoting from the API docs:
which shows the Categorical / Cateogorical.from_codes constructors. This implies that the rest of the methods are not considered as public API. |
the problem is we cannot reference these from other doc-strings then. I suppose we could have a hidden section? |
I mainly wanted to reference |
I think we should just not reference them then, as you say yourself, the examples are also in People will actually typically look at Series.unique docstring when they work interactively and have a categorical series. And looking at that now, there are no examples included there, but all are in |
we have a
Categorical
section, but this mainly describes.cat
. Maybe split this out into a separate section to document the actualCategorical
methods / accessors (even though it is slightly duplicative.http://pandas-docs.github.io/pandas-docs-travis/api.html#categorical
also need to add other public methods (that are not available on
.cat
). This is actually a big list, things like:isnull
,unique
,map
,value_counts
, etc.These are all Series like methods / accessors.
The text was updated successfully, but these errors were encountered: