Merge pull request #30 from kanwei/master

typos are indeed bad.

Author: GraylinKim

README.txt

@@ -48,7 +48,7 @@ See the sc2replay `wiki`_ for additional usage details (coming soon).
 Current Status
 ---------------
 
-sc2reader is written to parse replays where ``buidl >= 16561`` (generally
+sc2reader is written to parse replays where ``build >= 16561`` (generally
 version 1.1 replays). This means that the following information can be
 extracted:
 
@@ -69,7 +69,7 @@ Requirements
 ~~~~~~~~~~~~~
 
 - Python 2.6+, Python 3.0 untested
-- The `mpyq`_ MPQ exraction library
+- The `mpyq`_ MPQ extraction library
 - `pytest`_ testing library (optional)
 
 Basic Install

sc2reader/__init__.py

@@ -5,7 +5,7 @@
 
     A Starcraft II replay parsing library intended to promote innovation in
     Starcraft tools and communities. Eventually, it will cover all official
-    releases and dump easily to JSON for inter-language portabilty.
+    releases and dump easily to JSON for inter-language portability.
 
     sc2reader has been carefully written for clarity to serve as a starting
     point for those who want to write their own parsers, potentially in other
@@ -42,7 +42,7 @@ class accepts a key=value list of options to override defaults (see
 
     def __init__(self, **user_options):
         """ The constructor makes a copy of the default_options to make sure the
-            option configuration doesn't propogate back to the default_options.
+            option configuration doesn't propagate back to the default_options.
             It should support any arbitrary number of different Reader objects.
         """
         self.options = config.default_options.copy()
@@ -181,7 +181,7 @@ def read_file(self, file_in, **user_options):
         # Support file-like objects (with a read method)
         if hasattr(file_in, 'read') and hasattr(file_in, 'seek'):
 
-            # Base the options off a copy to leave the Reader options uneffected.
+            # Base the options off a copy to leave the Reader options unaffected.
             options = self.options.copy()
             options.update(user_options)
 
@@ -202,7 +202,7 @@ def read_file(self, file_in, **user_options):
 
 """sc2reader uses a default SC2Reader class instance to provide a package level
 interface to its functionality. The package level interface presents the same
-functional interface, it just saves the hassel of creating the class object.
+functional interface, it just saves the hassle of creating the class object.
 """
 __defaultReader = Reader()
 

sc2reader/data.py

@@ -951,7 +951,7 @@ class Broodling(GameObject, Unit, Zerg):
     code = 0xcf01
 class Changeling(GameObject, Unit, Zerg):
     code = 0x2601
-    # TODO insta-change beween them 
+    # TODO insta-change between them 
 class ChangelingZealot(GameObject):
     code = 0x2701
 class ChangelingMarine(GameObject):

sc2reader/objects.py

@@ -269,7 +269,7 @@ class Event(object):
     name = 'BaseEvent'
     def apply(self): pass
 
-    """Abstract Event Type, should not be directly instanciated"""
+    """Abstract Event Type, should not be directly instantiated"""
     def __init__(self, timestamp, player_id, event_type, event_code):
         self.frame = timestamp
         self.second = timestamp >> 4
@@ -450,7 +450,7 @@ def apply(self):
             obj.visit(self.frame, self.player)
 
     def __str__(self):
-        return HotkeyEvent.__str__(self) + " - Add; Seletion: %s" % str(self.selected)
+        return HotkeyEvent.__str__(self) + " - Add; Selection: %s" % str(self.selected)
 
 class GetHotkeyEvent(HotkeyEvent):
     name = 'GetHotkeyEvent'
@@ -470,7 +470,7 @@ def apply(self):
             obj.visit(self.frame, self.player)
 
     def __str__(self):
-        return HotkeyEvent.__str__(self) + " - Get; Seletion: %s" % str(self.selected)
+        return HotkeyEvent.__str__(self) + " - Get; Selection: %s" % str(self.selected)
 
 class SelectionEvent(Event):
     name = 'SelectionEvent'

sc2reader/parsers.py

@@ -262,7 +262,7 @@ def parse_020E_event(self, buffer, frames, type, code, pid):
 
 class CameraParser(object):
     def parse_camera87_event(self, buffer, frames, type, code, pid):
-        #There are up to 3 peices to read depending on values encountered
+        #There are up to 3 pieces to read depending on values encountered
         for i in range(3):
             if buffer.read_int(BIG_ENDIAN) & 0xF0 == 0:
                 break
@@ -273,7 +273,7 @@ def parse_cameraX8_event(self, buffer, frames, type, code, pid):
         # No idea why these two cases are ever so slightly different. There
         # must be a pattern in here somewhere that I haven't found yet.
         #
-        # TODO: Find out why we occassionally shift by 2 instead of 3
+        # TODO: Find out why we occasionally shift by 2 instead of 3
         if code == 0x88:
             flags = buffer.read_byte()
             extra = buffer.read_byte()

sc2reader/processors.py

@@ -36,7 +36,7 @@ def Full(replay):
         replay.is_ladder = (replay.category == "Ladder")
         replay.is_private = (replay.category == "Private")
 
-    #If we don't atleast have details and attributes_events we can go no further
+    #If we don't at least have details and attributes_events we can go no further
     if not ('details' in replay.raw and 'attributes_events' in replay.raw):
         return replay
 
@@ -64,7 +64,7 @@ def Full(replay):
 
         # Create the player using the current pid and the player name from
         # The details file. This works because players are stored in order
-        # of pid intside of the details file. Attributes and Details must be
+        # of pid inside of the details file. Attributes and Details must be
         # processed together because Details doesn't index players by or
         # store their player ids; Attributes can provide that information
         # and allow for accurate pid mapping even with computers, observers,
@@ -126,7 +126,7 @@ def Full(replay):
     if 'initData' in replay.raw:
         # Assign the default region to computer players for consistency
         # We know there will be a default region because there must be
-        # atleast 1 human player or we wouldn't have a replay.
+        # at least 1 human player or we wouldn't have a replay.
         for player in replay.players:
             if player.type == 'Computer':
                 player.region = default_region
@@ -139,7 +139,7 @@ def Full(replay):
             replay.people.append(observer)
             replay.person[i+1] = observer
 
-    # Miscellenious people processing
+    # Miscellaneous people processing
     replay.humans = filter(lambda p: p.type == 'Human', replay.people)
 
     if 'message_events' in replay.raw:
@@ -258,7 +258,7 @@ def Full(replay):
 
                     # If there are any big teams left or more than one 1 person
                     # team left this is definitely either a loss or a really
-                    # akward tie between 3 or more people on 2 or more teams.
+                    # awkward tie between 3 or more people on 2 or more teams.
                     #
                     # Since I don't think ties can be detected, ignore that case
                     if len(pcount) > 2 or big_teams:

sc2reader/readers.py

@@ -129,7 +129,7 @@ def __call__(self, buffer, replay):
         # we don't need to use data[0][0][1][3] to get the battle.net player id.
         # The field names are documented in the namedtuples section of the
         # objects file. The ordered_values function extracts the values while
-        # maintaining key order required for propper mapping
+        # maintaining key order required for proper mapping
         ordered_values = lambda dict: [v for k,v in sorted(dict.iteritems())]
 
         # Because named tuples are read only, we need to build them in pieces
@@ -241,7 +241,7 @@ def __call__(self, buffer, replay):
 
             except ParseError:
                 # For some reason, the type handler that we delegated to didn't
-                # recognize the event code that we extracated.
+                # recognize the event code that we extracted.
                 # TODO: Do something meaningful here
                 raise ReadError("Unknown event code", type, code, start, replay, game_events, buffer)
 
@@ -258,9 +258,9 @@ def __call__(self, buffer, replay):
     def get_setup_parser(self, code):
         # The setup events typically form a header of sorts to the file with
         # each player (in no particular order) registering a join event and
-        # the game starting immediately afterwords. On occassion, for unknown
+        # the game starting immediately afterwords. On occasion, for unknown
         # reasons, other events (particularly camera events) will register
-        # before the game has actually started. Wierd.
+        # before the game has actually started. Weird.
         if   code in (0x0B, 0x0C, 0x2C): return self.parse_join_event
         elif code in (0x05,): return self.parse_start_event
         else:

sc2reader/utils.py

@@ -14,7 +14,7 @@
 
 class ReplayBuffer(object):
     """ The ReplayBuffer is a wrapper over the cStringIO object and provides
-        convenience functions for reading structured data from Stacraft II
+        convenience functions for reading structured data from Starcraft II
         replay files. These convenience functions can be sorted into several
         different categories providing an interface as follows:
 
@@ -25,7 +25,7 @@ class ReplayBuffer(object):
             align(self)
             seek(self, position, mode=SEEK_CUR)
 
-        Data Retrival::
+        Data Retrieval::
             read_variable_int(self)
             read_string(self,additional)
             read_timestamp(self)
@@ -250,7 +250,7 @@ def read_data_struct(self):
         elif datatype == 0x09:
             return self.read_variable_int()
 
-        raise TypeError("Uknown Data Structure: '%s'" % datatype)
+        raise TypeError("Unknown Data Structure: '%s'" % datatype)
 
     def read_object_type(self, read_modifier=False):
         """ Object type is big-endian short16 """
@@ -313,7 +313,7 @@ def read_range(self, start, end):
     def shift(self, bits):
         """
         The only valid use of Buffer.shift is when you know that there are
-        enough bits left in the loaded byte to accomodate your request.
+        enough bits left in the loaded byte to accommodate your request.
 
         If there is no loaded byte, or the loaded byte has been exhausted,
         then Buffer.shift(8) could technically be used to read a single
@@ -545,7 +545,7 @@ def read_header(file):
             http://wiki.devklog.net/index.php?title=The_MoPaQ_Archive_Format
 
         Return the release array and frame count for sc2reader use. For more
-        defailted header information, access mpyq directly.
+        detailed header information, access mpyq directly.
     '''
     buffer = ReplayBuffer(file)