LE for style guide consistency (you-focus, spelling, list format, capitalization)

Author: KateFinegan

top-python-game-engines/adventurelib/adventurelib_basic.py

@@ -1,17 +1,17 @@
 """
-Basic Hello World program in AdventureLib
+Basic "Hello, World!" program in adventurelib
 
 This program is designed to demonstrate the basic capabilities
-of AdventureLib. It will:
-- Create a simple three room world
+of adventurelib. It will:
+- Create a simple three-room world
 - Add a single inventory item
 - Require that inventory item to move to the final room
 """
 
 # Import the library contents
 import adventurelib as adv
 
-# Define our rooms
+# Define your rooms
 bedroom = adv.Room(
     """
 You are in your bedroom. The bed is unmade, but otherwise
@@ -38,9 +38,9 @@
 bedroom.south = living_room
 living_room.east = front_porch
 
-# Define a constraint to move from the bedroom to the livingroom
+# Define a constraint to move from the bedroom to the living room
 # If the door between the living room and front porch door is locked,
-# we can't exit
+# you can't exit
 living_room.locked = {"east": True}
 
 # None of the other rooms have any locked doors
@@ -61,7 +61,7 @@ def unlock_living_room(current_room):
         print("There is nothing to unlock here.")
 
 
-# Create our items
+# Create your items
 key = adv.Item("a front door key", "key")
 key.use_item = unlock_living_room
 
@@ -73,11 +73,11 @@ def unlock_living_room(current_room):
 # Put the key in the bedroom
 bedroom.contents.add(key)
 
-# Setup our current empty inventory
+# Set up your current empty inventory
 inventory = adv.Bag()
 
 
-# Define our movement commands
+# Define your movement commands
 @adv.when("go DIRECTION")
 @adv.when("north", direction="north")
 @adv.when("south", direction="south")
@@ -88,16 +88,16 @@ def unlock_living_room(current_room):
 @adv.when("e", direction="east")
 @adv.when("w", direction="west")
 def go(direction: str):
-    """Processes our moving direction
+    """Processes your moving direction
 
     Arguments:
         direction {str} -- which direction does the player want to move
     """
 
-    # What is our current room
+    # What is your current room?
     global current_room
 
-    # Is there an exit in that direction
+    # Is there an exit in that direction?
     next_room = current_room.exit(direction)
     if next_room:
         # Is the door locked?
@@ -113,7 +113,7 @@ def go(direction: str):
         print(f"You can't go {direction}.")
 
 
-# How do we look at the room
+# How do you look at the room?
 @adv.when("look")
 def look():
     """Looks at the current room"""
@@ -130,20 +130,20 @@ def look():
     print(f"The following exits are present: {current_room.exits()}")
 
 
-# How do we look at items?
+# How do you look at items?
 @adv.when("look at ITEM")
 @adv.when("inspect ITEM")
 def look_at(item: str):
 
-    # Check if the item is in our inventory or not
+    # Check if the item is in your inventory or not
     obj = inventory.find(item)
     if not obj:
         print(f"You don't have {item}.")
     else:
         print(f"It's an {obj}.")
 
 
-# How do we pick up items?
+# How do you pick up items?
 @adv.when("take ITEM")
 @adv.when("get ITEM")
 @adv.when("pickup ITEM")
@@ -163,7 +163,7 @@ def get(item: str):
         inventory.add(obj)
 
 
-# How do we use an item?
+# How do you use an item?
 @adv.when("unlock door", item="key")
 @adv.when("use ITEM")
 def use(item: str):
@@ -175,7 +175,7 @@ def use(item: str):
 
     global inventory
 
-    # First, do we have the item?
+    # First, do you have the item?
     obj = inventory.take(item)
     if not obj:
         print(f"You don't have {item}")
@@ -186,7 +186,7 @@ def use(item: str):
 
 
 if __name__ == "__main__":
-    # Look at out starting room
+    # Look at the starting room
     look()
 
     adv.start()

top-python-game-engines/adventurelib/adventurelib_game.py

@@ -1,40 +1,40 @@
 """
-Complete game written in AdventureLib
+Complete game written in adventurelib
 
 This program is designed to demonstrate the capabilities
-of AdventureLib. It will:
+of adventurelib. It will:
 - Create a large world in which to wander
 - Contain several inventory items
 - Set contexts for moving from one area to another
-- Require some puzzle solving skills
+- Require some puzzle-solving skills
 """
 
 # Import the library contents
 # from adventurelib import *
 import adventurelib as adv
 
-# Import our rooms, which imports our items and characters
+# Import your rooms, which imports your items and characters
 import adventurelib_game_rooms
 
 import adventurelib_game_items
 
-# For our battle sequence
+# For your battle sequence
 from random import randint
 
-# To allow us to exit the game
+# To allow you to exit the game
 import sys
 
 # Set the first room
 current_room = adventurelib_game_rooms.home
 current_room.visited = False
 
-# How many HP do we have
+# How many HP do you have?
 hit_points = 20
 
 # How many HP does the giant have?
 giant_hit_points = 50
 
-# Our current inventory
+# Your current inventory
 inventory = adv.Bag()
 
 
@@ -66,7 +66,7 @@ def look_at(item: str):
     # Check if the item is in the room
     obj = current_room.items.find(item)
     if not obj:
-        # Check if the item is in our inventory
+        # Check if the item is in your inventory
         obj = inventory.find(item)
         if not obj:
             print(f"I can't find {item} anywhere.")
@@ -80,7 +80,7 @@ def look_at(item: str):
 def describe(item: str):
     """Prints a description of an item if it is either:
     1. in the current room, or
-    2. in our inventory
+    2. in your inventory
 
     Arguments:
         item {str} -- the item to look at
@@ -91,7 +91,7 @@ def describe(item: str):
     # Check if the item is in the room
     obj = current_room.items.find(item)
     if not obj:
-        # Check if the item is in our inventory
+        # Check if the item is in your inventory
         obj = inventory.find(item)
         if not obj:
             print(f"I can't find {item} anywhere.")
@@ -121,7 +121,7 @@ def take_item(item: str):
 def eat(item: str):
     global inventory
 
-    # Make sure we have the thing first
+    # Make sure you have the thing first
     obj = inventory.find(item)
 
     # Do you have this thing?
@@ -142,14 +142,14 @@ def eat(item: str):
 def wear(item: str):
     global inventory
 
-    # Make sure we have the thing first
+    # Make sure you have the thing first
     obj = inventory.find(item)
 
     # Do you have this thing?
     if not obj:
         print(f"You don't have {item}.")
 
-    # Is it wearable
+    # Is it wearable?
     elif obj.wearable:
         print(f"The {obj.description} makes a wonderful fashion statement!")
 
@@ -160,7 +160,7 @@ def wear(item: str):
         )
 
 
-# Some character specific commands
+# Some character-specific commands
 @adv.when("talk to CHARACTER")
 def talk_to(character: str):
     global current_room
@@ -412,7 +412,7 @@ def flee():
 @adv.when("later")
 def goodbye():
 
-    # Are we fighting the giant?
+    # Are you fighting the giant?
     if adv.get_context() == "giant":
         # Not so fast!
         print("The giant steps in front of you, blocking your exit!")
@@ -427,7 +427,7 @@ def goodbye():
 @adv.when("look")
 def look():
     """Print the description of the current room.
-    If we've already visited it, print a short description.
+    If you've already visited it, print a short description.
     """
     global current_room
 
@@ -452,7 +452,7 @@ def describe_room():
         print(f"There is {item.description} here.")
 
 
-# Define our movement commands
+# Define your movement commands
 @adv.when("go DIRECTION")
 @adv.when("north", direction="north")
 @adv.when("south", direction="south")
@@ -463,16 +463,16 @@ def describe_room():
 @adv.when("e", direction="east")
 @adv.when("w", direction="west")
 def go(direction: str):
-    """Processes our moving direction
+    """Processes your moving direction
 
     Arguments:
         direction {str} -- which direction does the player want to move
     """
 
-    # What is our current room
+    # What is your current room
     global current_room
 
-    # Is there an exit in that direction
+    # Is there an exit in that direction?
     next_room = current_room.exit(direction)
     if next_room:
         # Is the door locked?
@@ -510,7 +510,7 @@ def my_prompt():
     # Get possible exits
     exits_string = get_exits(current_room)
 
-    # Are we in battle?
+    # Are you in battle?
     if adv.get_context() == "giant":
         prompt_string = f"HP: {hit_points} > "
     else:
@@ -549,7 +549,7 @@ def get_exits(room):
     # What happens with unknown commands
     adv.no_command_matches = my_no_command_matches
 
-    # Look at our starting room
+    # Look at your starting room
     look()
 
     # Start the game

top-python-game-engines/adventurelib/adventurelib_game_characters.py

@@ -1,15 +1,15 @@
 """
-Characters for the AdventureLib Game
+Characters for the adventurelib Game
 """
 
-# Import the AdventureLib library
+# Import the adventurelib library
 import adventurelib as adv
 
 # All characters have some properties
 adv.Item.greeting = ""
 adv.Item.context = ""
 
-# Our characters
+# Your characters
 elder_barron = adv.Item("Elder Barron", "elder", "barron")
 elder_barron.description = """Elder Barron, a tall distinguished member
 of the community. His steely grey hair and stiff beard inspire confidence."""

top-python-game-engines/adventurelib/adventurelib_game_items.py

@@ -1,8 +1,8 @@
 """
-Items for the AdventureLib Game
+Items for the adventurelib Game
 """
 
-# Import the AdventureLib library
+# Import the adventurelib library
 import adventurelib as adv
 
 # All items have some basic properties
@@ -11,8 +11,7 @@
 adv.Item.edible = False
 adv.Item.wearable = False
 
-# Create our "flavor" items
-# Apple
+# Create your "flavor" items
 apple = adv.Item("small red apple", "apple")
 apple.color = "red"
 apple.description = "a small ripe red apple"
@@ -33,7 +32,7 @@
 slug.edible = True
 slug.wearable = False
 
-# Create the real items we need
+# Create the real items you need
 wooden_sword = adv.Item("wooden sword", "sword")
 wooden_sword.color = "brown"
 wooden_sword.description = (

top-python-game-engines/adventurelib/adventurelib_game_rooms.py

@@ -1,14 +1,14 @@
 """
-Rooms for the AdventureLib game
+Rooms for the adventurelib game
 """
 
 # Import the library contents
 import adventurelib as adv
 
-# Import our items as well
+# Import your items as well
 import adventurelib_game_items
 
-# And our characters
+# And your characters
 import adventurelib_game_characters
 
 
@@ -32,7 +32,7 @@ def __init__(self, description: str):
         self.characters = adv.Bag()
 
         # All areas may have been visited already
-        # If so, we can print a shorter description
+        # If so, you can print a shorter description
         self.visited = False
 
         # Which means each area needs a shorter description
@@ -176,7 +176,7 @@ def __init__(self, description: str):
 giant_cave.title = "Cave of the Giant"
 giant_cave.short_desc = "You are in the giant's cave."
 
-# Setup the paths between areas
+# Set up the paths between areas
 home.south = hamlet
 hamlet.south = fork
 fork.west = village