Skip to content

DOC: Add SparseDataFrame and SparseSeries to the API docs #17993

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

Closed
TomAugspurger opened this issue Oct 26, 2017 · 2 comments · Fixed by #28425
Closed

DOC: Add SparseDataFrame and SparseSeries to the API docs #17993

TomAugspurger opened this issue Oct 26, 2017 · 2 comments · Fixed by #28425
Labels
Docs Sparse Sparse Data Type

Comments

@TomAugspurger
Copy link
Contributor

We have some references them that don't resolve currently, since the classes aren't there.

Unfortunately it looks like adding SparseDataFrame causes a failure like

ValueError: %(klass)s.notna : boolean inverse of isna is not a item name
[70] > /Users/taugspurger/Envs/pandas-dev/lib/python3.6/site-packages/pandas/doc/sphinxext/numpydoc/docscrape.py(210)parse_item_name()
-> raise ValueError("%s is not a item name" % text)
(Pdb++) Building HTML failed.
@TomAugspurger TomAugspurger added this to the Next Major Release milestone Oct 26, 2017
@TomAugspurger TomAugspurger added the Sparse Sparse Data Type label Oct 26, 2017
@jorisvandenbossche
Copy link
Member

I would first like to see a way to somehow limit the number of api pages (eg a way to only build pages for methods that are overwritten) before adding such a big new chunk to the api pages.

@TomAugspurger
Copy link
Contributor Author

Yeah, we should only include the methods we actually refer to.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Sparse Sparse Data Type
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants