add documentations

Author: patrickZWY

social_posters/mastodon.py

@@ -73,6 +73,9 @@ def authenticate(self) -> bool:
             self._auth_error = f"{type(exc).__name__}: {exc}"
             return False
 
+    """
+    Main Mastodon publishing logic
+    """
     def publish(self, post: Post) -> PostResult:
         error = self._ensure_ready_to_publish(post)
         if error:
@@ -153,7 +156,7 @@ def _post_thread(
 
     """
     Implement your own pipeline and consume it in a preview file
-    for debugging purposes
+    for previewing/debugging purposes
     Here, we build a pipeline from AdoptablePet (upstream input)
     -> Post -> Prepared Caption -> Caption Thread
     """
@@ -310,6 +313,9 @@ def _safe_truncate(text: str, limit: int) -> tuple[str, str]:
 
         return text[:cut].rstrip(), text[cut:].strip()
 
+    """
+    Override abstractions.py method
+    """
     def format_post(self, pet: AdoptablePet) -> Post:
         text = (
             f"Meet {pet.name}! This adorable {pet.breed} {pet.species} "

utils/pipeline.py

@@ -6,7 +6,9 @@
     PipelineResult[T] + Callable[[T], U] -> PipelineResult[U]
 
 For example:
+    T:AdoptablePet -> (T:AdoptablePet -> U:Post) outputs U:Post
 
+Whole Pipeline:
     AdoptablePet -> Post -> PreparedCaption -> CaptionThread
 
 The trace stores every intermediate phase value for preview/debug output,