diff options
| author | kotfu <kotfu@kotfu.net> | 2020-02-22 20:44:11 -0700 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2020-02-22 20:44:11 -0700 |
| commit | e034b67130de6bfd41199391e3933ef21414fa42 (patch) | |
| tree | 2af70fd97c46aab0bda8d7d59cde2fbfe0b6e0af /docs/overview | |
| parent | acf269f07f9437a54d8b02491ed1db3da05f374f (diff) | |
| download | cmd2-git-e034b67130de6bfd41199391e3933ef21414fa42.tar.gz | |
Clarify that the API documentation is the public API.
Diffstat (limited to 'docs/overview')
| -rw-r--r-- | docs/overview/integrating.rst | 7 |
1 files changed, 5 insertions, 2 deletions
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 <https://semver.org>`_, 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 <https://packaging.python.org/discussions/install-requires-vs-requirements/>`_. By setting an upper bound on the allowed version, you can ensure that your project does not inadvertently get installed with an incompatible future |