Skip to content

Explicitly include "private" ExtensionArray methods in API docs #24067

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
Closed
TomAugspurger opened this issue Dec 3, 2018 · 0 comments · Fixed by #27279
Closed

Explicitly include "private" ExtensionArray methods in API docs #24067

TomAugspurger opened this issue Dec 3, 2018 · 0 comments · Fixed by #27279
Labels
Docs ExtensionArray Extending pandas with custom dtypes or arrays. good first issue

Comments

@TomAugspurger
Copy link
Contributor

Seems like the developer methods like _values_for_facotrize are excluded from autodoc.

http://pandas-docs.github.io/pandas-docs-travis/generated/pandas.api.extensions.ExtensionArray.html#pandas.api.extensions.ExtensionArray

We should be able to explicitly list out the methods / attributes that are public.

May have to change the template to autosummary/class_without_autosummary.rst like Categorical.
@TomAugspurger TomAugspurger added Docs good first issue ExtensionArray Extending pandas with custom dtypes or arrays. labels Dec 3, 2018
@TomAugspurger TomAugspurger added this to the Contributions Welcome milestone Dec 3, 2018
@TomAugspurger TomAugspurger mentioned this issue Dec 3, 2018
Merged
@tadeja tadeja mentioned this issue Jul 7, 2019
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs ExtensionArray Extending pandas with custom dtypes or arrays. good first issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: Explicitly include "private" ExtensionArray methods in API docs tadeja/pandas
1 participant
@TomAugspurger