Fix docs for NOTHING

python-attrs · Aug 8, 2022 · 2358f8e · 2358f8e
1 parent 36d942a
commit 2358f8e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -28,6 +28,7 @@ Core
   Therefore if a class, method, or function claims that it has been added in an older version, it is only available in the ``attr`` namespace.
 
 .. autodata:: attrs.NOTHING
+   :no-value:
 
 .. autofunction:: attrs.define
 

diff --git a/src/attr/_make.py b/src/attr/_make.py
@@ -49,13 +49,13 @@
 
 class _Nothing(enum.Enum):
     """
-    Sentinel class to indicate the lack of a value when ``None`` is ambiguous.
+    Sentinel to indicate the lack of a value when ``None`` is ambiguous.
 
-    This is an Enum so that the single variant can be used as a `Literal` for
-    type checking tools.
+    If extending attrs, you can use ``typing.Literal[NOTHING]`` to show
+    that a value may be ``NOTHING``.
 
     .. versionchanged:: 21.1.0 ``bool(NOTHING)`` is now False.
-    .. versionchanged:: 22.2.0 ``NOTHING`` is now an `enum.Enum` variant.
+    .. versionchanged:: 22.2.0 ``NOTHING`` is now an ``enum.Enum`` variant.
     """
 
     NOTHING = enum.auto()