Add docstrings updates

Author: acsany

python-docstrings/docstring_format.py

@@ -2,3 +2,4 @@ def determine_magic_level(magic_number):
     """
     Multiply a wizard's favorite number by 3 to reveal their magic level.
     """
+    return magic_number * 3

python-docstrings/get_potter_books.py

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

python-docstrings/google_style.py

@@ -4,9 +4,12 @@ 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): include a potions option.
+        include_potions (bool, optional): Whether to include potions in the result.
 
     Returns:
         list[str]: A list of item names associated with the user.
     """
-    return ["wand", "cloak", "crystal ball"]
+    items = ["wand", "cloak", "crystal ball"]
+    if include_potions:
+        items.extend(["healing potion", "invisibility potion"])
+    return items

python-docstrings/minimal_return_details_fix.py

@@ -8,3 +8,4 @@ def generate_shield(strength):
     Returns:
         str: A human-readable description of the generated shield.
     """
+    return f"Shield with strength {strength}"

python-docstrings/navigation.py

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

python-docstrings/restructuredText.py

@@ -1,7 +1,7 @@
 def cast_spell(wand, incantation, target=None):
     """
     Cast a magical spell using a wand and incantation.
-    This function stimulates casting a spell. With no
+    This function simulates casting a spell. With no
     target specified, it is cast into the void.
 
     :param wand: The wand used to do the spell-casting deed.
@@ -18,7 +18,7 @@ def cast_spell(wand, incantation, target=None):
     if not wand:
         raise ValueError("You can't cast spells without a wand!")
     if incantation not in valid_incantations:
-        raise ValueError("Incantation not recognozed.")
+        raise ValueError("Incantation not recognized.")
     if target:
         return f"{incantation} hits {target} with magic speed!"
     return f"{incantation} is cast into the void...sparkles shimmer faintly"

python-docstrings/vague_descriptions_fix.py

@@ -8,3 +8,4 @@ def brew(potion_ingredients):
     Returns:
         str: The name of the completed potion.
     """
+    return f"Magical potion brewed from {', '.join(potion_ingredients)}"