more docstrings for commands.py

Brendan Whitfield · Brendan Whitfield · commit 38618a4dc428 · 2015-04-19T15:22:48.000-04:00
diff --git a/obd/commands.py b/obd/commands.py
@@ -201,6 +201,14 @@ def __init__(self):
 
 
     def __getitem__(self, key):
+        """
+            commands can be accessed by name, or by mode/pid
+
+            obd.commands.RPM
+            obd.commands["RPM"]
+            obd.commands[1][12] # mode 1, PID 12 (RPM)
+        """
+
         if isinstance(key, int):
             return self.modes[key]
         elif isinstance(key, str) or isinstance(key, unicode):
@@ -210,18 +218,20 @@ def __getitem__(self, key):
 
 
     def __len__(self):
+        """ returns the number of commands supported by python-OBD """
         l = 0
         for m in self.modes:
             l += len(m)
         return l
 
 
     def __contains__(self, s):
+        """ calls has_name(s) """
         return self.has_name(s)
 
 
-    # returns a list of PID GET commands
     def pid_getters(self):
+        """ returns a list of PID GET commands """
         getters = []
         for m in self.modes:
             for c in m:
@@ -230,35 +240,35 @@ def pid_getters(self):
         return getters
 
 
-    # sets the boolean supported flag for the given command 
     def set_supported(self, mode, pid, v):
+        """ sets the boolean supported flag for the given command """
         if isinstance(v, bool):
             if self.has(mode, pid):
                 self.modes[mode][pid].supported = v
         else:
             debug("set_supported() only accepts boolean values", True)
 
 
-    # checks for existance of command by OBDCommand object
     def has_command(self, c):
+        """ checks for existance of a command by OBDCommand object """
         if isinstance(c, OBDCommand):
             return c in self.__dict__.values()
         else:
             debug("has_command() only accepts OBDCommand objects", True)
             return False
 
 
-    # checks for existance of command by name
     def has_name(self, s):
+        """ checks for existance of a command by name """
         if isinstance(s, str) or isinstance(s, unicode):
             return s.isupper() and (s in self.__dict__.keys())
         else:
             debug("has_name() only accepts string names for commands", True)
             return False
 
 
-    # checks for existance of int mode and int pid
     def has_pid(self, mode, pid):
+        """ checks for existance of a command by int mode and int pid """
         if isinstance(mode, int) and isinstance(pid, int):
             if (mode < 0) or (pid < 0):
                 return False
