Skip to content

DOC: document public/private subpackages in api.rst #16087

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

Merged
merged 1 commit into from
Apr 21, 2017
Merged

DOC: document public/private subpackages in api.rst #16087

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions doc/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@
API Reference
*************

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, including ``pandas.errors``,
``pandas.plotting``, and ``pandas.testing``. Certain functions in the the
``pandas.io`` and ``pandas.tseries`` submodules are public as well (those
mentioned in the documentation). Further, the ``pandas.api.types`` subpackage
holds some public functions related to data types in pandas.


.. warning::

The ``pandas.core``, ``pandas.compat``, and ``pandas.util`` top-level modules are considered to be PRIVATE. Stability of functionality in those modules in not guaranteed.


.. _api.functions:

Input/Output
Expand Down Expand Up @@ -1896,3 +1912,30 @@ Testing functions
testing.assert_frame_equal
testing.assert_series_equal
testing.assert_index_equal


Exceptions and warnings
~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated/

errors.DtypeWarning
errors.EmptyDataError
errors.OutOfBoundsDatetime
errors.ParserError
errors.ParserWarning
errors.PerformanceWarning
errors.UnsortedIndexError
errors.UnsupportedFunctionCall


Data types related functionality
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

infer_dtype as well

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

(for now I left out the is_* ones, as they don't all have a docstring yet)

api.types.union_categoricals
api.types.infer_dtype
api.types.pandas_dtype