DOC: document public/private subpackages in api.rst #16087
Conversation
doc/source/api.rst
Outdated
| This page gives an overview of all public pandas objects, functions and | ||
| methods. In general, all classes and functions exposed in the top-level | ||
| ``pandas.*`` namespace are regarded as public. | ||
| Further some of the subpackages are public as well, including `pandas.errors``, |
There was a problem hiding this comment.
Missing an opening backtick.
And could these all be be links?
:mod:`pandas.errors`
Though I don't think we do any module-level things in the toctree, so maybe not.
There was a problem hiding this comment.
yeah, I don't think such links would currently work. But we could make such pages. That would actually maybe not bad for the subpackages, to have one page with all functions, instead of each function on a separate page.
But anyway, that is for another PR
Codecov Report
@@ Coverage Diff @@
## master #16087 +/- ##
==========================================
+ Coverage 90.84% 90.85% +<.01%
==========================================
Files 159 159
Lines 50774 50790 +16
==========================================
+ Hits 46127 46143 +16
Misses 4647 4647
Continue to review full report at Codecov.
|
|
|
||
| .. autosummary:: | ||
| :toctree: generated/ | ||
|
|
There was a problem hiding this comment.
done
(for now I left out the is_* ones, as they don't all have a docstring yet)
jorisvandenbossche
force-pushed
the
api-docs-public
branch
from
f672517 to
bee8769
Compare
WIP (have to run now)