updated doc strings

docforge/models/module.py

@@ -1,7 +1,10 @@
 """
-This module defines the Module class, which represents a Python module or package
-in the doc-forge documentation models. It acts as a container for top-level
-documented objects.
+Documentation model representing a Python module or package.
+
+This module defines the ``Module`` class used in the doc-forge documentation
+model. A ``Module`` acts as a container for top-level documented objects
+(classes, functions, variables, and other members) discovered during
+introspection.
 """
 
 from typing import Dict, Iterable, Optional
@@ -11,12 +14,17 @@ from docforge.models.object import DocObject
 
 class Module:
     """
-    Represents a documented Python module or package.
+    Representation of a documented Python module or package.
+
+    A ``Module`` stores metadata about the module itself and maintains a
+    collection of top-level documentation objects discovered during
+    introspection.
 
     Attributes:
         path: Dotted import path of the module.
-        docstring: Module-level docstring content.
-        members: Dictionary mapping object names to their DocObject representations.
+        docstring: Module-level documentation string, if present.
+        members: Mapping of object names to their corresponding
+            ``DocObject`` representations.
     """
 
     def __init__(
@@ -25,11 +33,11 @@ class Module:
         docstring: Optional[str] = None,
     ) -> None:
         """
-        Initialize a new Module.
+        Initialize a Module instance.
 
         Args:
-            path: The dotted path of the module.
-            docstring: The module's docstring, if any.
+            path: Dotted import path identifying the module.
+            docstring: Module-level documentation text, if available.
         """
         self.path = path
         self.docstring = docstring
@@ -40,27 +48,32 @@ class Module:
         Add a documented object to the module.
 
         Args:
-            obj: The object to add.
+            obj: Documentation object to register as a top-level
+                member of the module.
         """
         self.members[obj.name] = obj
 
     def get_object(self, name: str) -> DocObject:
         """
-        Retrieve a member object by name.
+        Retrieve a documented object by name.
 
         Args:
-            name: The name of the object.
+            name: Name of the object to retrieve.
 
         Returns:
-            The requested DocObject.
+            The corresponding ``DocObject`` instance.
+
+        Raises:
+            KeyError: If no object with the given name exists.
         """
         return self.members[name]
 
     def get_all_objects(self) -> Iterable[DocObject]:
         """
-        Get all top-level objects in the module.
+        Return all top-level documentation objects in the module.
 
         Returns:
-            An iterable of DocObject instances.
+            An iterable of ``DocObject`` instances representing the
+            module's public members.
         """
         return self.members.values()