From e034b67130de6bfd41199391e3933ef21414fa42 Mon Sep 17 00:00:00 2001 From: kotfu Date: Sat, 22 Feb 2020 20:44:11 -0700 Subject: Clarify that the API documentation is the public API. --- docs/overview/integrating.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'docs/overview') diff --git a/docs/overview/integrating.rst b/docs/overview/integrating.rst index 0cc7816e..db5cb206 100644 --- a/docs/overview/integrating.rst +++ b/docs/overview/integrating.rst @@ -10,8 +10,11 @@ include ``cmd2``. Make sure your ``setup.py`` includes the following:: The ``cmd2`` project uses `Semantic Versioning `_, which means that any incompatible API changes will be release with a new major -version number. We recommend that you follow the advice given by the Python -Packaging User Guide related to `install_requires +version number. The public API is documented in the :ref:`api/index:API +Reference`. + +We recommend that you follow the advice given by the Python Packaging User +Guide related to `install_requires `_. By setting an upper bound on the allowed version, you can ensure that your project does not inadvertently get installed with an incompatible future -- cgit v1.2.1