Skip to content

Commit e034b67

Browse files
committed
Clarify that the API documentation is the public API.
1 parent acf269f commit e034b67

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

docs/api/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
API Reference
22
=============
33

4+
These pages document the public API for ``cmd2``. If a method, class, function,
5+
attribute, or constant is not documented here, consider it private and subject
6+
to change. There are many classes, methods, functions, and constants in the
7+
source code which do not begin with an underscore but are not documented here.
8+
When looking at the source code for this library, you can not safely assume
9+
that because something doesn't start with an underscore, it is a public API.
10+
11+
If a release of this library changes any of the items documented here, the
12+
version number will be incremented according to the `Semantic Version
13+
Specification <https://semver.org>`_.
14+
15+
This documentation is for version |version| of ``cmd2``.
16+
417
.. toctree::
518
:maxdepth: 1
619

docs/overview/integrating.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,11 @@ include ``cmd2``. Make sure your ``setup.py`` includes the following::
1010

1111
The ``cmd2`` project uses `Semantic Versioning <https://semver.org>`_, which
1212
means that any incompatible API changes will be release with a new major
13-
version number. We recommend that you follow the advice given by the Python
14-
Packaging User Guide related to `install_requires
13+
version number. The public API is documented in the :ref:`api/index:API
14+
Reference`.
15+
16+
We recommend that you follow the advice given by the Python Packaging User
17+
Guide related to `install_requires
1518
<https://packaging.python.org/discussions/install-requires-vs-requirements/>`_.
1619
By setting an upper bound on the allowed version, you can ensure that your
1720
project does not inadvertently get installed with an incompatible future

0 commit comments

Comments
 (0)