fixup! feat: add docstring prompt

Author: mtth

src/git_draft/prompt.py

@@ -16,11 +16,12 @@ class TemplatedPrompt:
 
     @classmethod
     def parse(cls, name: str, *args: str) -> Self:
-        """Parse arguments into a TemplatedPrompt.
+        """Parse arguments into a TemplatedPrompt
 
         Args:
             name: The name of the template.
-            *args: Additional arguments for context, expected in 'key=value' format.
+            *args: Additional arguments for context, expected in 'key=value'
+                format.
         """
         return cls(name, dict(e.split("=", 1) for e in args))
 

src/git_draft/prompts/add-docstrings.jinja

@@ -16,7 +16,7 @@ examples:
 
 ```python
 def write_file(path: Path, contents: str) -> None:
-    """Update a file's contents
+    """Updates a file's contents
 
     Args:
         path: Path to the file to update.
@@ -30,4 +30,8 @@ class Renderer:
     ...
 ```
 
+Additionally, the first paragraph of each docstring should fit in a single line
+and not include a period at the end. It should be a brief summary of the
+symbol's functionality.
+
 {% include "includes/file-list.jinja" %}