Correct __add_initial_message_headers doc block

ECN · Aug 2, 2021 · 80cc1cb · 80cc1cb
1 parent 84cb7b4
commit 80cc1cb
Showing 1 changed file with 3 additions and 6 deletions.
diff --git a/src/webqueue2api/parser/item.py b/src/webqueue2api/parser/item.py
@@ -251,16 +251,13 @@ def __parse_sections(self) -> list:
         return body_sections
 
     def __add_initial_message_headers(self, initial_message: dict) -> dict:
-        """Adds header information to the intial message
-
-        Example:
-                [example]
+        """Adds header information to the intial message.
 
         Args:
-                initial_message (dict): the intial message dictionary without any headers
+                initial_message (dict): The intial message dictionary without headers.
 
         Returns:
-                dict: modified initial message dictionary to include headers
+                dict: Initial message dictionary with headers.
         """
         raw_cc = self.__get_most_recent_header_by_type("CC")
         raw_to = self.__get_most_recent_header_by_type("To")