updated docs strings and added README.md

mail_intake/ingestion/reader.py

@@ -1,18 +1,17 @@
 """
+# Summary
+
 High-level mail ingestion orchestration for Mail Intake.
 
----
-
-## Summary
-
 This module provides the primary, provider-agnostic entry point for
 reading and processing mail data.
 
 It coordinates:
-- Mail adapter access
-- Message and thread iteration
-- Header and body parsing
-- Normalization and model construction
+
+- Mail adapter access.
+- Message and thread iteration.
+- Header and body parsing.
+- Normalization and model construction.
 
 No provider-specific logic or API semantics are permitted in this layer.
 """
@@ -36,12 +35,18 @@ class MailIntakeReader:
     Notes:
         **Responsibilities:**
 
-            - This class is the primary entry point for consumers of the Mail Intake library
-            - It orchestrates the full ingestion pipeline: Querying the adapter for message references, fetching raw provider messages, parsing and normalizing message data, constructing domain models
+            - This class is the primary entry point for consumers of the
+              Mail Intake library.
+            - It orchestrates the full ingestion pipeline:
+                - Querying the adapter for message references.
+                - Fetching raw provider messages.
+                - Parsing and normalizing message data.
+                - Constructing domain models.
 
         **Constraints:**
-        
-            - This class is intentionally: Provider-agnostic, stateless beyond iteration scope, read-only
+
+            - This class is intentionally: Provider-agnostic, stateless beyond
+              iteration scope, read-only.
     """
 
     def __init__(self, adapter: MailIntakeAdapter):
@@ -87,13 +92,14 @@ class MailIntakeReader:
                 An iterator of `MailIntakeThread` instances.
 
         Raises:
-            MailIntakeParsingError:
+            `MailIntakeParsingError`:
                 If a message cannot be parsed.
 
         Notes:
             **Guarantees:**
 
-                - Messages are grouped by `thread_id` and yielded as complete thread objects containing all associated messages
+                - Messages are grouped by `thread_id` and yielded as complete
+                  thread objects containing all associated messages.
         """
         threads: Dict[str, MailIntakeThread] = {}