Post final QA

Author: bzaczynski

python-docstrings/get_potter_books.py

@@ -1,3 +1,3 @@
-from multi_line_docstring import get_harry_potter_books
+from multiline_docstring import get_harry_potter_books
 
 print(get_harry_potter_books.__doc__)

python-docstrings/google_style.py

@@ -4,7 +4,7 @@ def get_magic_items(user_id, include_potions=False):
 
     Args:
         user_id (int): The ID of the user whose items should be retrieved.
-        include_potions (bool, optional): Whether to include potions in the result.
+        include_potions (bool, optional): Whether to include potions.
 
     Returns:
         list[str]: A list of item names associated with the user.

python-docstrings/magic_spells.py

@@ -1,12 +1,12 @@
 def undo_spell(spell):
     """
-    Reverses characters in a spell incantation thereby undoing a spell.
+    Reverses characters in a spell incantation, thereby undoing a spell.
 
     Example:
     >>> undo_spell("Expelliarmus")
-    "sumraillepxE"
+    'sumraillepxE'
 
     >>> undo_spell("Lumos")
-    "somuL"
+    'somuL'
     """
     return spell[::-1]

python-docstrings/magical_characters.py

@@ -1,4 +1,4 @@
-"""A magical module for adding and listing magical characters."""
+"""A module for adding and listing magical characters."""
 
 
 def add_characters(magical_being):

python-docstrings/multi_line_docstring.py renamed to python-docstrings/multiline_docstring.py

@@ -1,14 +1,12 @@
-def get_harry_potter_books(publication_year, book_name):
+def get_harry_potter_book(publication_year, title):
     """
     Retrieve a Harry Potter book by its publication year and name.
 
     Parameters:
     publication_year (int): The year the book was published.
-    book_name (str): The name of the book.
+    title (str): The title of the book.
 
     Returns:
     str: A sentence describing the book and its publication year.
     """
-    return (
-        f"The book {book_name} was published in the year {publication_year}."
-    )
+    return f"The book {title!r} was published in the year {publication_year}."

python-docstrings/navigation.py

@@ -1,5 +1,6 @@
 """
 This module provides tools for creating and managing magical maps.
+
 Example:
     from navigation import build_map
     build_map(["mandrake", "phoenix feather", "tree bark"], heat_level=3)

python-docstrings/one_line_docstring.py

@@ -2,6 +2,6 @@
 
 
 def picking_hat():
-    """Returns a random house name."""
+    """Return a random house name."""
     houses = ["Gryffindor", "Hufflepuff", "Ravenclaw", "Slytherin"]
     return random.choice(houses)