updated doc strings

docforge/models/object.py

@@ -1,7 +1,10 @@
 """
-This module defines the DocObject class, the fundamental recursive unit of the
-doc-forge documentation models. A DocObject represents a single Python entity
-(class, function, method, or attribute) and its nested members.
+Documentation model representing individual Python objects.
+
+This module defines the ``DocObject`` class, the fundamental recursive unit of
+the doc-forge documentation model. Each ``DocObject`` represents a Python
+entity such as a class, function, method, or attribute, and may contain nested
+members that form a hierarchical documentation structure.
 """
 
 from typing import Dict, Iterable, Optional
@@ -9,15 +12,20 @@ from typing import Dict, Iterable, Optional
 
 class DocObject:
     """
-    Represents a documented Python object (class, function, method, etc.).
+    Representation of a documented Python object.
+
+    A ``DocObject`` models a single Python entity discovered during
+    introspection. Objects may contain nested members, allowing the structure
+    of modules, classes, and other containers to be represented recursively.
 
     Attributes:
         name: Local name of the object.
-        kind: Type of object (e.g., 'class', 'function', 'attribute').
-        path: Full dotted import path to the object.
-        signature: Callable signature, if applicable.
-        docstring: Raw docstring content extracted from the source.
-        members: Dictionary mapping member names to their DocObject representations.
+        kind: Type of object (for example ``class``, ``function``,
+            ``method``, or ``attribute``).
+        path: Fully qualified dotted path to the object.
+        signature: Callable signature if the object represents a callable.
+        docstring: Raw docstring text extracted from the source code.
+        members: Mapping of member names to child ``DocObject`` instances.
     """
 
     def __init__(
@@ -29,48 +37,54 @@ class DocObject:
         docstring: Optional[str] = None,
     ) -> None:
         """
-        Initialize a new DocObject.
+        Initialize a DocObject instance.
 
         Args:
-            name: The local name of the object.
-            kind: The kind of object (e.g., 'class', 'function').
-            path: The full dotted path to the object.
-            signature: The object's signature (for callable objects).
-            docstring: The object's docstring, if any.
+            name: Local name of the object.
+            kind: Object type identifier (for example ``class`` or ``function``).
+            path: Fully qualified dotted path of the object.
+            signature: Callable signature if applicable.
+            docstring: Documentation string associated with the object.
         """
         self.name = name
         self.kind = kind
         self.path = path
         self.signature = signature
         self.docstring = docstring
-        self.members: Dict[str, 'DocObject'] = {}
+        self.members: Dict[str, "DocObject"] = {}
 
-    def add_member(self, obj: 'DocObject') -> None:
+    def add_member(self, obj: "DocObject") -> None:
         """
-        Add a child member to this object (e.g., a method to a class).
+        Add a child documentation object.
+
+        This is typically used when attaching methods to classes or
+        nested objects to their parent containers.
 
         Args:
-            obj: The child DocObject to add.
+            obj: Documentation object to add as a member.
         """
         self.members[obj.name] = obj
 
-    def get_member(self, name: str) -> 'DocObject':
+    def get_member(self, name: str) -> "DocObject":
         """
-        Retrieve a child member by name.
+        Retrieve a member object by name.
 
         Args:
-            name: The name of the member.
+            name: Name of the member to retrieve.
 
         Returns:
-            The requested DocObject.
+            The corresponding ``DocObject`` instance.
+
+        Raises:
+            KeyError: If the member does not exist.
         """
         return self.members[name]
 
-    def get_all_members(self) -> Iterable['DocObject']:
+    def get_all_members(self) -> Iterable["DocObject"]:
         """
-        Get all members of this object.
+        Return all child members of the object.
 
         Returns:
-            An iterable of child DocObject instances.
+            An iterable of ``DocObject`` instances representing nested members.
         """
         return self.members.values()