diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/doc_conventions.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/doc_conventions.rst b/docs/doc_conventions.rst index 49149d7c..c37a4825 100644 --- a/docs/doc_conventions.rst +++ b/docs/doc_conventions.rst @@ -201,6 +201,9 @@ for multiple matching references is high, which causes Sphinx to generate warnings. The build pipeline that renders the documentation treats warnings as fatal errors. It's best to just be specific about what you are referencing. +See `<https://github.com/python-cmd2/cmd2/issues/821>`_ for the discussion of +how we determined this approach. + Referencing cmd2 ----------------- |