add docstrings

Author: gesslerpd

.github/workflows/publish.yml

@@ -9,8 +9,10 @@ permissions:
   contents: read
 
 jobs:
-  release-build:
+  pypi-publish:
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
 
     steps:
       - uses: actions/checkout@v4
@@ -21,29 +23,6 @@ jobs:
         run: |
           uv build
 
-      - name: Upload distributions
-        uses: actions/upload-artifact@v4
-        with:
-          name: release-dists
-          path: dist/
-
-  pypi-publish:
-    runs-on: ubuntu-latest
-    needs:
-      - release-build
-    permissions:
-      id-token: write
-
-    environment:
-      name: pypi
-      url: https://pypi.org/p/runtime-docstrings
-
-    steps:
-      - name: Retrieve release distributions
-        uses: actions/download-artifact@v4
-        with:
-          name: release-dists
-          path: dist/
-
       - name: Publish release distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
+        run: |
+          uv publish

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "runtime-docstrings"
-version = "0.1.0"
+version = "0.1.1"
 description = "Runtime access to Python class attribute docstrings (PEP 224)"
 readme = "README.md"
 authors = [{ name = "gesslerpd", email = "[email protected]" }]

src/runtime_docstrings/_parser.py

@@ -9,9 +9,6 @@
 import ast
 import types
 from enum import Enum
-from typing import TypeVar
-
-T = TypeVar("T", bound=type)
 
 
 def _parse_docstrings(node: ast.ClassDef) -> dict[str, str]:
@@ -35,6 +32,15 @@ def _parse_docstrings(node: ast.ClassDef) -> dict[str, str]:
 
 
 def get_docstrings(cls: type) -> dict[str, str]:
+    """Parse and return a mapping of attribute names to their docstrings for a given class.
+
+    Args:
+        cls: The class to parse attribute docstrings from.
+
+    Returns:
+        A dictionary where keys are attribute names and values are their
+        corresponding docstrings.
+    """
     if "__attribute_docs__" in cls.__dict__:
         return cls.__attribute_docs__
     source = dedent(inspect.getsource(cls))
@@ -76,7 +82,18 @@ def _attach_enum(cls: type[Enum], comments: dict[str, str]) -> None:
                 member.__doc__ = comments[name]
 
 
-def docstrings(cls: T) -> T:
+def docstrings(cls: type) -> type:
+    """Decorator that attaches attribute/member docstrings to a class.
+
+    If the class is an enum, docstrings are attached via enum members.
+
+    If the class is a dataclass, docstrings are attached via field metadata.
+
+    Parameters:
+        cls: The class to process.
+    Returns:
+        The same class with attached docstrings.
+    """
     assert inspect.isclass(cls), "cls must be a class"
 
     # Extract docstrings from the class definition