Merge pull request #79 from timgates42/bugfix_typos

docs: Fix a few typos

Author: braiden

antd/ant.py

@@ -204,7 +204,7 @@ def wait_and_retry_policy(error):
 
 # matcher define the strategry to determine
 # if an incoming message from ANT device sould
-# udpate the status of a running command.
+# update the status of a running command.
 
 def same_channel_or_network_matcher(request, reply):
     return (
@@ -244,7 +244,7 @@ def send_data_matcher(request, reply):
             and reply.msg_id == 1
             and reply.msg_code in (EVENT_TX, EVENT_TRANSFER_TX_COMPLETED, EVENT_TRANSFER_TX_FAILED)))
 
-# validators define stragegy for determining
+# validators define strategy for determining
 # if a give reply from ANT should raise an
 # error. 
 
@@ -354,7 +354,7 @@ def __str__(self):
 # Synthetic Commands
 UnimplementedCommand = message(None, "UNIMPLEMENTED_COMMAND", None, None, ["msg_id", "msg_contents"])
 
-# hack, capabilites may be 4 (AP1) or 6 (AP2) bytes
+# hack, capabilities may be 4 (AP1) or 6 (AP2) bytes
 class Capabilities(message(DIR_IN, "CAPABILITIES", 0x54, "BBBB", ["max_channels", "max_networks", "standard_opts", "advanced_opts1"])):
 
     @classmethod
@@ -371,7 +371,7 @@ def unpack_args(cls, packed_args):
 class ReadData(RequestMessage):
     """
     A phony command which is pushed to request data from client.
-    This command will remain runnning as long as the channel is
+    This command will remain running as long as the channel is
     in a state where read is valid, and raise error if channel
     transitions to a state where read is impossible. Its kind-of
     an ugly hack so that channel status causes exceptions in read.
@@ -638,7 +638,7 @@ def _send(self, cmd, timeout=1, retry=0):
             # HACK, need to clean this up. not all devices support sending
             # a response message for ResetSystem, so don't bother waiting for it
             if not isinstance(cmd, ResetSystem):
-                # set expiration and event on command. Once self.runnning_cmd
+                # set expiration and event on command. Once self.running_cmd
                 # is set access to this command from this thread is invalid 
                 # until event object is set.
                 cmd.expiration = time.time() + timeout if timeout > 0 else None

antd/antfs.py

@@ -288,7 +288,7 @@ def search(self, search_timeout=60, device_id=None, include_unpaired_devices=Fal
                     if  beacon.device_state != Beacon.STATE_LINK:
                         _log.warning("Device busy, not ready for link. device_number=0x%04x state=%d.",
                                 tracking_device_number, beacon.device_state)
-                    # are we looking for a sepcific device
+                    # are we looking for a specific device
                     if device_id is not None:
                         if device_id == tracking_device_id:
                             # the device exactly matches the one we're looking for
@@ -303,7 +303,7 @@ def search(self, search_timeout=60, device_id=None, include_unpaired_devices=Fal
                             continue
                     elif not include_unpaired_devices and tracking_device_id is None:
                         # requested not to return unpared devices
-                        # but the one linked is unkown.
+                        # but the one linked is unknown.
                         # FIXME add device to AP2 filter and contiue search
                         _log.debug("Found device, but paring not enabled. device_number=0x%04x", tracking_device_number)
                         continue
@@ -348,7 +348,7 @@ def auth(self, pair=True, timeout=60):
         with the device we are currenly linked. Not
         valid unless device is in link status.
         If a client key is known, transport will be
-        openned without user interaction. If key is unkown
+        openned without user interaction. If key is unknown
         we will attempt to pair with device (which must
         be acknowledged by human on GPS device.)
         If paising is not enabled Auth is impossible.
@@ -381,7 +381,7 @@ def auth(self, pair=True, timeout=60):
                 _log.warning("Device pairing failed. Removing key from db. Try re-pairing.")
                 self.known_client_keys.delete_device(client_id)
         elif pair:
-            _log.debug("Device unkown, requesting pairing.")
+            _log.debug("Device unknown, requesting pairing.")
             auth_cmd = Auth(Auth.OP_PAIR, ANTFS_HOST_NAME)
             self.channel.write(auth_cmd.pack())
             while True:
@@ -395,7 +395,7 @@ def auth(self, pair=True, timeout=60):
             else:
                 _log.warning("Device pairing failed. Request rejected?")
         else:
-            _log.warning("Device 0x08%x has data but pairing is disabled and key is unkown.", client_id)
+            _log.warning("Device 0x08%x has data but pairing is disabled and key is unknown.", client_id)
         #confirm the ANT-FS channel is open
         self.beacon = Beacon.unpack(self.channel.recv_broadcast(0))
         assert self.beacon.device_state == Beacon.STATE_TRANSPORT

antd/cfg.py

@@ -55,7 +55,7 @@ def read(file=None):
             write_default_config(file)
     read = _cfg.read([file])
     if read:
-        # config file read sucessfuelly, setup logger
+        # config file read successfully, setup logger
         _log.setLevel(logging.WARNING)
         init_loggers()
         # check for version mismatch

antd/garmin.py

@@ -33,7 +33,7 @@
 types in specification. Currently this class only implementes
 the necessary protocols and datatypes  to dynamically discover
 device capaibilties and save runs. The spec was last updated
-in 2006, so some datatypes include undocumented/unkown fields.
+in 2006, so some datatypes include undocumented/unknown fields.
 """
 
 import logging
@@ -475,7 +475,7 @@ def execute(self):
         """
         A generator or array which contains either a tuple
         representing a command which should be executed
-        or a protocol (who's execute shoudl be deletaged to.
+        or a protocol (who's execute should be deletaged to.
         """
         return []
 
@@ -683,7 +683,7 @@ def _parse(self, type, arg_name=None):
         """
         Invoke a composite data type to parse
         from start of this instance's unparsed text.
-        If arg_name is provided, reulst will be
+        If arg_name is provided, result will be
         assigned as attribute of this instance.
         """
         data = type(self.unparsed)
@@ -925,7 +925,7 @@ def __init__(self, data):
 
 class DeviceNotSupportedError(Exception):
     """
-    Raised device capabilites lack capabilites
+    Raised device capabilities lack capabilities
     to complete request.
     """
 

antd/main.py

@@ -78,7 +78,7 @@ def downloader():
         while failed_count <= antd.cfg.get_retry():
             try:
                 _log.info("Searching for ANT devices.")
-                # in daemon mode we do not attempt to pair with unkown devices
+                # in daemon mode we do not attempt to pair with unknown devices
                 # (it requires gps watch to wake up and would drain battery of
                 # any un-paired devices in range.)
                 beacon = host.search(include_unpaired_devices=not args.daemon,

antd/plugin.py

@@ -47,7 +47,7 @@ def data_available(self, device_sn, format, files):
         Notification that data is available, this could
         be raw packet data from device, or higher level
         data generated by other plugins, e.g. TCX.
-        Return: files which were sucessfullly processed.
+        Return: files which were successfully processed.
         """
         pass