From bb0ce1b2b00eeb2a5f6894e188196929261d96e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20Kl=C3=B6ckner?= <inform@tiker.net> Date: Fri, 23 Apr 2021 13:43:08 -0500 Subject: [PATCH] Move pytools.tag docstring to top, fix copy reference --- pytools/tag.py | 57 +++++++++++++++++++++++--------------------------- 1 file changed, 26 insertions(+), 31 deletions(-) diff --git a/pytools/tag.py b/pytools/tag.py index 47b00f7..38c987b 100644 --- a/pytools/tag.py +++ b/pytools/tag.py @@ -1,3 +1,29 @@ +""" + +Tag Interface +--------------- +.. ``normalize_tags`` undocumented for now. (Not ready to commit.) + +.. autofunction:: check_tag_uniqueness +.. autoclass:: Taggable +.. autoclass:: Tag +.. autoclass:: UniqueTag + +Supporting Functionality +------------------------ + +.. autoclass:: DottedName +.. autoclass:: NonUniqueTagError + + +Internal stuff that is only here because the documentation tool wants it +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. class:: T_co + + A covariant type variable used in, e.g. :meth:`Taggable.copy`. +""" + from dataclasses import dataclass from typing import Tuple, Set, Any, FrozenSet, Union, Iterable, TypeVar from pytools import memoize @@ -30,37 +56,6 @@ THE SOFTWARE. """ -# {{{ docs - -__doc__ = """ - -Tag Interface ---------------- -.. ``normalize_tags`` undocumented for now. (Not ready to commit.) - -.. autofunction:: check_tag_uniqueness -.. autoclass:: Taggable -.. autoclass:: Tag -.. autoclass:: UniqueTag - -Supporting Functionality ------------------------- - -.. autoclass:: DottedName -.. autoclass:: NonUniqueTagError - - -Internal stuff that is only here because the documentation tool wants it -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. class:: T_co - - A covariant type variable used in, e.g. :class:`Taggable.copy`. -""" - -# }}} - - # {{{ dotted name class DottedName: -- GitLab