From 69fa5046d66f560094430ae629b7da1614068a26 Mon Sep 17 00:00:00 2001
From: Andreas Kloeckner <inform@tiker.net>
Date: Fri, 23 Apr 2021 01:08:34 -0500
Subject: [PATCH] Fully qualify rest refs in pytools.tag docstrings
---
pytools/tag.py | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/pytools/tag.py b/pytools/tag.py
index fcf16ac..4da13d7 100644
--- a/pytools/tag.py
+++ b/pytools/tag.py
@@ -243,15 +243,19 @@ class Taggable:
.. versionadded:: 2021.1
"""
+ # ReST references in docstrings must be fully qualified, as docstrings may
+ # be inherited and appear in different contexts.
+
def __init__(self, tags: TagsType = frozenset()):
"""
Constructor for all objects that possess a `tags` attribute.
- :arg tags: a :class:`frozenset` of :class:`Tag` objects. Tags can
- be modified via the :meth:`tagged` and :meth:`without_tags`
- routines. Input checking of *tags* should be performed before
- creating a :class:`Taggable` instance, using
- :func:`check_tag_uniqueness`.
+ :arg tags: a :class:`frozenset` of :class:`~pytools.tag.Tag` objects.
+ Tags can be modified via the :meth:`~pytools.tag.Taggable.tagged` and
+ :meth:`~pytools.tag.Taggable.without_tags` routines. Input checking
+ of *tags* should be performed before creating a
+ :class:`~pytools.tag.Taggable` instance, using
+ :func:`~pytools.tag.check_tag_uniqueness`.
"""
self.tags = tags
--
GitLab