raise error instead of a warning for unresolvable attrs

harshil21 · Jun 16, 2026 · May 7, 2026 · May 20, 2026 · May 20, 2026 · May 20, 2026
commit 2fa51195955b7686cf52cbb936a7332a6c74da6f
diff --git a/docs/auxil/attribute_inserter.py b/docs/auxil/attribute_inserter.py
@@ -1,4 +1,3 @@
-#
 #  A library that provides a Python interface to the Telegram Bot API
 #  Copyright (C) 2015-2026
 #  Leandro Toledo de Souza <devs@python-telegram-bot.org>
@@ -232,10 +231,9 @@ def insert_attributes(self, obj: type, lines: list[str]) -> None:
                 and slot not in args_names
                 and slot not in properties_on_class
             ):
-                warnings.warn(
+                raise RuntimeError(
                     f"Class {obj.__qualname__!r}: public slot {slot!r} has no documentation "
                     f"source. Please add it to the 'Attributes:' section manually.",
-                    stacklevel=2,
                 )
 
         new_attr_lines: list[str] = []

diff --git a/docs/auxil/sphinx_hooks.py b/docs/auxil/sphinx_hooks.py
@@ -104,7 +104,6 @@ def autodoc_process_docstring(
 
     # 1) Insert the Keyword Args and "Shortcuts" admonitions for the Bot methods
     method_name = name.rsplit(".", maxsplit=1)[-1]
-    # object_signature = inspect.signature(obj) if callable(obj) else None
     if (
         name.startswith("telegram.Bot.")
         and what == "method"
@@ -154,7 +153,7 @@ def autodoc_process_docstring(
 
     # 2-4) Insert "Returned in", "Available in", "Use in" admonitions into classes
     # (where applicable)
-    if what == "class":
+    if what in ("class", "exception"):
         # Auto-generate Attributes section entries from Args before admonitions are inserted
         ATTRIBUTE_INSERTER.insert_attributes(
             obj=typing.cast("type", obj),

diff --git a/tests/docs/attribute_inserter.py b/tests/docs/attribute_inserter.py
@@ -488,8 +488,8 @@ def value(self) -> int:
         # No Attributes section should be created because 'value' is a property.
         assert "Attributes:" not in lines
 
-    def test_undocumented_public_slot_warns(self, inserter):
-        """A public own slot with no Args entry and no Attributes entry raises a warning."""
+    def test_undocumented_public_slot_raises(self, inserter):
+        """A public own slot with no Args entry and no Attributes entry raises an error."""
 
         class _MyClass:
             __slots__ = ("computed",)
@@ -498,7 +498,7 @@ class _MyClass:
             "Args:",
             "    name (:obj:`str`): The name.",
         ]
-        with pytest.warns(UserWarning, match="public slot 'computed'"):
+        with pytest.raises(RuntimeError, match="public slot 'computed'"):
             inserter.insert_attributes(_MyClass, lines)
 
     def test_rst_substitution_after_attributes_not_swallowed(self, inserter):
@@ -555,14 +555,14 @@ def test_sequence_classargs_substitution_optional(self, inserter):
         assert "|tupleclassattrs|" not in "\n".join(attrs_block)
         assert "|alwaystuple|" not in "\n".join(attrs_block)
 
-    def test_no_args_section_slot_warns(self, inserter):
-        """No Args section but class has undocumented public slot -> warning."""
+    def test_no_args_section_slot_raises(self, inserter):
+        """No Args section but class has undocumented public slot -> raises."""
 
         class _MyClass:
             __slots__ = ("computed",)
 
         lines = ["Just a description."]
-        with pytest.warns(UserWarning, match="public slot 'computed'"):
+        with pytest.raises(RuntimeError, match="public slot 'computed'"):
             inserter.insert_attributes(_MyClass, lines)
         # Lines unchanged (no args to generate from)
         assert "Attributes:" not in lines