summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkotfu <kotfu@kotfu.net>2020-02-14 22:32:00 -0700
committerkotfu <kotfu@kotfu.net>2020-02-14 22:32:00 -0700
commit627ecc1dd6c3797d17bf589b51b0c0d75fc79593 (patch)
treee51d35f964c9d5526fb3ba9cbaf03c683d4bef9d
parent1e1480507108271a2ba77e1a469582c8944e2c60 (diff)
downloadcmd2-git-627ecc1dd6c3797d17bf589b51b0c0d75fc79593.tar.gz
Add link to issue for more detail on how we determined our attribute documentation approach
-rw-r--r--docs/doc_conventions.rst3
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
-----------------