Fix lint issues

python · hugovk · Jul 22, 2025 · Jun 6, 2025 · Jun 8, 2025 · Jun 8, 2025
commit fcd74e64c74492873d42533d45fc5200919a7a80
@@ -17,11 +17,11 @@
 .. _templatelib-template:

 Template
 --------
 
-The :class:`Template` class describes the contents of a template string.
+The :class:`!Template` class describes the contents of a template string.
 
-The most common way to create a new :class:`Template` instance is to use the t-string literal syntax. This syntax is identical to that of :ref:`f-strings`, except that the string is prefixed with a ``t`` instead of an ``f``. For example, the following code creates a :class:`Template` that can be used to format strings:
+The most common way to create a new :class:`!Template` instance is to use the t-string literal syntax. This syntax is identical to that of :ref:`f-strings`, except that the string is prefixed with a ``t`` instead of an ``f``. For example, the following code creates a :class:`Template` that can be used to format strings:
 
    >>> name = "World"
    >>> greeting = t"Hello {name}!"
@@ -30,7 +30,7 @@
    >>> print(list(greeting))
    ['Hello ', Interpolation('World', 'name', None, ''), '!']
 
-It is also possible to create a :class:`Template` directly, using its constructor. This takes an arbitrary collection of strings and :class:`Interpolation` instances:
+It is also possible to create a :class:`!Template` directly, using its constructor. This takes an arbitrary collection of strings and :class:`Interpolation` instances:
 
    >>> from string.templatelib import Interpolation, Template
    >>> name = "World"
@@ -40,7 +40,7 @@
 
 .. class:: Template(*args)
 
-   Create a new :class:`Template` object.
+   Create a new :class:`!Template` object.
 
    :param args: A mix of strings and :class:`Interpolation` instances in any order.
    :type args: str | Interpolation
@@ -112,7 +112,7 @@
 
 .. class:: Interpolation(*args)
 
-   Create a new :class:`Interpolation` object.
+   Create a new :class:`!Interpolation` object.
 
    :param value: The evaluated, in-scope result of the interpolation.
    :type value: object
@@ -126,7 +126,7 @@
    :param format_spec: An optional, arbitrary string used as the :ref:`format specification <formatspec>` to present the value.
    :type expression: str = ""
 
-   The :class:`Interpolation` type represents an expression inside a template string. It is shallow immutable -- its attributes cannot be reassigned.
+   The :class:`!Interpolation` type represents an expression inside a template string. It is shallow immutable -- its attributes cannot be reassigned.
 
    >>> name = "World"
    >>> template = t"Hello {name}"
@@ -137,7 +137,7 @@
     File "<input>", line 1, in <module>
   AttributeError: readonly attribute

   While f-strings and t-strings are largely similar in syntax and expectations, the :attr:`~Interpolation.conversion` and :attr:`~Interpolation.format_spec` behave differently. With f-strings, these are applied to the resulting value automatically. For example, in this ``format_spec``:

   >>> value = 42
   >>> f"Value: {value:.2f}"

@@ -926,15 +926,16 @@
 syntax and evaluation rules as `formatted string literals <f-strings>`_, with
 the following differences:
 
-- Rather than evaluating to a `str` object, t-strings evaluate to a
-  `Template` object from the :mod:`string.templatelib` module.
+- Rather than evaluating to a ``str`` object, t-strings evaluate to a
+  :class:`~string.templatelib.Template` object from the
- Rather than evaluating to a ``str`` object, t-strings evaluate to a
-  :class:`~string.templatelib.Template` object from the
+* Rather than evaluating to a ``str`` object, template string literals evaluate
+  to a :class:`~string.templatelib.Template` object from the
- Rather than evaluating to a ``str`` object, t-strings evaluate to a
-  :class:`~string.templatelib.Template` object from the
+* Rather than evaluating to a ``str`` object, template string literals evaluate
+  to a :class:`~string.templatelib.Template` object from the
+  :mod:`string.templatelib` module.
 
 - Evaluated expressions are *not* formatted using the
   :func:`format` protocol; :meth:`~object.__format__` is *not* invoked. Instead,
-  the expressions are evaluated and a new `Interpolation` object (also from the
-  :mod:`string.templatelib` module) is created, which contains the evaluated
-  value of the expression. That `Interpolation` object is found in the containing
-  `Template`.
+  the expressions are evaluated and a new :class:`~string.templatelib.Interpolation``
+  object (also from the :mod:`string.templatelib` module) is created, which
+  contains the evaluated value of the expression. That ``Interpolation`` object
+  is found in the containing ``Template``.