updated doc strings

docforge/renderers/base.py

@@ -1,7 +1,9 @@
 """
-This module defines the base interfaces and configuration containers for
-doc-forge renderers. All renderer implementations should adhere to the
-DocRenderer protocol.
+Renderer base interfaces and configuration models.
+
+This module defines the base protocol and configuration container used by
+doc-forge renderers. Concrete renderer implementations should implement the
+``DocRenderer`` protocol.
 """
 
 from pathlib import Path
@@ -14,12 +16,22 @@ class RendererConfig:
     """
     Configuration container for documentation renderers.
 
-    Args:
-        out_dir: The directory where documentation files should be written.
-        project: The introspected project models to be rendered.
+    A ``RendererConfig`` instance groups together the project model and the
+    output directory used during rendering.
+
+    Attributes:
+        out_dir: Directory where generated documentation files will be written.
+        project: Documentation project model to be rendered.
     """
 
     def __init__(self, out_dir: Path, project: Project) -> None:
+        """
+        Initialize a RendererConfig instance.
+
+        Args:
+            out_dir: Target directory where documentation files should be written.
+            project: Introspected project model to render.
+        """
         self.out_dir = out_dir
         self.project = project
 
@@ -27,6 +39,9 @@ class RendererConfig:
 class DocRenderer(Protocol):
     """
     Protocol defining the interface for documentation renderers.
+
+    Implementations of this protocol are responsible for transforming a
+    ``Project`` model into renderer-specific documentation sources.
     """
 
     name: str
@@ -37,10 +52,11 @@ class DocRenderer(Protocol):
         out_dir: Path,
     ) -> None:
         """
-        Generate renderer-specific source files for the given project.
+        Generate renderer-specific documentation sources.
 
         Args:
-            project: The project models containing modules and objects.
-            out_dir: Target directory for the generated files.
+            project: Project model containing modules and documentation objects.
+            out_dir: Directory where generated documentation sources
+                should be written.
         """
         ...