Merge pull request #112 from cclauss/patch-2

CircleCI: Look for typos with codespell

Author: StoicLoofah

.circleci/config.yml

@@ -15,8 +15,9 @@ jobs:
       - image: circleci/python:3.8
     steps:
       - checkout
-      - run: sudo pip install flake8 black
+      - run: sudo pip install black codespell flake8
       - run: python --version ; pip --version ; pwd ; ls -l
+      - run: codespell -L queenland,uint
       # stop the build if there are Python syntax errors or undefined names
       - run: flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
       # exit-zero treats all errors as warnings.  The GitHub editor is 127 chars wide

CHANGELOG.rst

@@ -159,7 +159,7 @@ Changed Stuff (non-backwards compatible!):
 --------------------
 
 * Fixes several game event parsing issues for older replays.
-* Propperly maps ability ids for armory vehicle & ship armor upgrades.
+* Properly maps ability ids for armory vehicle & ship armor upgrades.
 * Uses the US depot for SEA battle.net depot dependencies.
 * ``PlayerStatEvent.food_used`` and ``food_made`` are now properly divided by 4096
 * ``AbilityEvent.flags`` are now processed into a dictionary mapping flag name to True/False (``AbilityEvent.flag``)

docs/source/articles/whatsinareplay.rst

@@ -35,7 +35,7 @@ The last file provides a record of important events from the game.
 
 * replay.tracker.events - Records important game events and game state updates.
 
-This file was introduced in 2.0.4 and is unncessary for the Starcraft II to reproduce the game. Instead, it records interesting game events and game state for community developers to use when analyzing replays.
+This file was introduced in 2.0.4 and is unnecessary for the Starcraft II to reproduce the game. Instead, it records interesting game events and game state for community developers to use when analyzing replays.
 
 
 What isn't in a replay?

docs/source/tutorials/prettyprinter.rst

@@ -93,7 +93,7 @@ Many of the replay attributes are nested data structures which are generally all
 
 Each of these nested structures can be found either on its own reference page or lumped together with the other minor structures on the Misc Structures page.
 
-So now all we need to do is build the ouput using the available replay attributes. Lets start with the header portion. We'll use a block string formatting method that makes this clean and easy:
+So now all we need to do is build the output using the available replay attributes. Lets start with the header portion. We'll use a block string formatting method that makes this clean and easy:
 
 ::
 
@@ -199,7 +199,7 @@ With this in mind, lets make a slight change to our main function to support any
 Any time that you start dealing with directories or collections of files you run into dangers with recursion and annoyances of tedium. sc2reader provides options to mitigate these concerns.
 
 * directory: Default ''. The directory string when supplied, becomes the base of all the file paths sent into sc2reader and can save you the hassle of fully qualifying your file paths each time.
-* depth: Default -1. When handling directory inputs, sc2reader searches the directory recursively until all .SC2Replay files have been loaded. By setting the maxium depth value this behavior can be mitigated.
+* depth: Default -1. When handling directory inputs, sc2reader searches the directory recursively until all .SC2Replay files have been loaded. By setting the maximum depth value this behavior can be mitigated.
 * exclude: Default []. When recursing directories you can choose to exclude  directories from the file search by directory name (not full path).
 * followlinks: Default false. When recursing directories, enables or disables the follow symlinks behavior.
 

examples/sc2autosave.py

@@ -37,7 +37,7 @@
 --------------------
 
 The --rename option allows you to specify a renaming format string. The string
-is constructed the pythonic (3.0) way with {:field} indicating the substition
+is constructed the pythonic (3.0) way with {:field} indicating the substitution
 of a field. The forward slash (/) is a special character here which terminates
 a folder name and allows for organization into subdirectories. All other string
 characters form the template into which the fields are inserted.
@@ -138,7 +138,7 @@
         files every SECONDS seconds.
     --rename FORMAT
         :map - Inserts the map name.
-        :date - Inserts a string formated datetime object using --date-format.
+        :date - Inserts a string formatted datetime object using --date-format.
         :length - Inserts a string formatted time object using --length-format.
         :teams - Inserts a comma separated player list. Teams are separated
             with a ' vs ' string. Format the player with --player-format.
@@ -602,7 +602,7 @@ def main():
     try:
         run(parser.parse_args())
     except KeyboardInterrupt:
-        print("\n\nScript Interupted. Process Aborting")
+        print("\n\nScript Interrupted. Process Aborting")
 
 
 if __name__ == "__main__":

sc2reader/data/__init__.py

@@ -84,7 +84,7 @@ def __init__(self, unit_id):
 
         #: The unique in-game id for this unit. The id can sometimes be zero because
         #: TargetUnitCommandEvents will create a new unit with id zero when a unit
-        #: behind the fog of war is targetted.
+        #: behind the fog of war is targeted.
         self.id = unit_id
 
         #: A reference to the unit type this unit is current in.
@@ -301,11 +301,11 @@ class Build(object):
     """
     :param build_id: The build number identifying this dataset.
 
-    The datapack for a particualr group of builds. Maps internal integer ids
+    The datapack for a particular group of builds. Maps internal integer ids
     to :class:`Unit` and :class:`Ability` types. Also contains builder methods
     for creating new units and changing their types.
 
-    All build data is valid for standard games only. For arcade maps milage
+    All build data is valid for standard games only. For arcade maps mileage
     may vary.
     """
 

sc2reader/decoders.py

@@ -20,7 +20,7 @@ class ByteDecoder(object):
     Used to unpack parse byte aligned files.
     """
 
-    #: The Bytes object used internaly for reading from the
+    #: The Bytes object used internally for reading from the
     #: decoder contents. cStringIO is faster than managing our
     #: own string access in python. For PyPy installations a
     #: managed string implementation might be faster.

sc2reader/engine/plugins/creeptracker.py

@@ -117,7 +117,7 @@ def __init__(self, replay):
             self.creep_spread_image_by_minute = dict()
         ## This list contains all the active cgus in every time frame
         self.creep_gen_units = dict()
-        ## Thist list corresponds to creep_gen_units storing the time of each CGU
+        ## This list corresponds to creep_gen_units storing the time of each CGU
         self.creep_gen_units_times = dict()
         ## convert all possible cgu radii into a sets of coordinates centred around the origin,
         ## in order to use this with the CGUs, the centre point will be
@@ -168,7 +168,7 @@ def radius_to_map_positions(self, radius):
         ## this function converts all radius into map coordinates
         ## centred around  the origin that the creep can exist
         ## the cgu_radius_to_map_position function will simply
-        ## substract every coordinate with the centre point of the tumour
+        ## subtract every coordinate with the centre point of the tumour
         output_coordinates = list()
         # Sample a square area using the radius
         for x in range(-radius, radius):

sc2reader/engine/plugins/selection.py

@@ -21,7 +21,7 @@ class SelectionTracker(object):
                 control_group_9 = selection[9]
                 active_selection = selection[10]
 
-        # TODO: list a few error inducing sitations
+        # TODO: list a few error inducing situations
     """
 
     name = "SelectionTracker"

sc2reader/engine/plugins/supply.py

@@ -87,7 +87,7 @@ def remove_from_units_alive(self, event, replay):
                 )
 
     def handleInitGame(self, event, replay):
-        ## This dictionary contains te supply of every unit
+        ## This dictionary contains the supply of every unit
         self.unit_name_to_supply = {
             # Zerg
             "Drone": (1, 17),