From ac1cfe726d0464837138e1970cf27822b961c6a7 Mon Sep 17 00:00:00 2001
From: Nicholas Christensen <njchris2@illinois.edu>
Date: Tue, 13 Oct 2020 01:48:11 -0500
Subject: [PATCH] add docstring

---
 pytools/tag.py | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

diff --git a/pytools/tag.py b/pytools/tag.py
index 4d44f24..d7de80e 100644
--- a/pytools/tag.py
+++ b/pytools/tag.py
@@ -27,6 +27,47 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 """
 
+# {{{ docs
+
+__doc__ = """
+.. currentmodule:: pytools
+
+Tag Interface
+---------------
+
+.. autoclass:: Tag
+.. autoclass:: UniqueTag
+
+Supporting Functionality
+------------------------
+
+.. autoclass:: DottedName
+
+.. currentmodule:: pytools.tag
+
+Aliases
+-------
+
+(This section exists because Sphinx, our documentation tool, can't (yet)
+canonicalize type references. Once Sphinx 4.0 is released, we should use the
+``:canonical:`` option here.)
+
+.. class:: DottedName
+
+    Should be referenced as :class:`pytools.DottedName`.
+
+.. class:: Tag
+
+    Should be referenced as :class:`pytools.Tag`.
+
+.. class:: UniqueTag
+
+    Should be referenced as :class:`pytools.UniqueTag`.
+"""
+
+# }}}
+
+
 # {{{ dotted name
 
 
-- 
GitLab