Skip to content

Commit 2f09f86

Browse files
Wilson Linjorisvandenbossche
Wilson Lin
authored andcommitted
DOC: Make API reference intro section concise (#19846)
1 parent 92dbc78 commit 2f09f86

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

doc/source/api.rst

+7-8
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,18 @@ API Reference
66
*************
77

88
This page gives an overview of all public pandas objects, functions and
9-
methods. In general, all classes and functions exposed in the top-level
10-
``pandas.*`` namespace are regarded as public.
9+
methods. All classes and functions exposed in ``pandas.*`` namespace are public.
1110

12-
Further some of the subpackages are public, including ``pandas.errors``,
13-
``pandas.plotting``, and ``pandas.testing``. Certain functions in the
14-
``pandas.io`` and ``pandas.tseries`` submodules are public as well (those
15-
mentioned in the documentation). Further, the ``pandas.api.types`` subpackage
16-
holds some public functions related to data types in pandas.
11+
Some subpackages are public which include ``pandas.errors``,
12+
``pandas.plotting``, and ``pandas.testing``. Public functions in
13+
``pandas.io`` and ``pandas.tseries`` submodules are mentioned in
14+
the documentation. ``pandas.api.types`` subpackage holds some
15+
public functions related to data types in pandas.
1716

1817

1918
.. warning::
2019

21-
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.
20+
The ``pandas.core``, ``pandas.compat``, and ``pandas.util`` top-level modules are PRIVATE. Stable functionality in such modules is not guaranteed.
2221

2322

2423
.. _api.functions:

0 commit comments

Comments
 (0)