Merge "Add a description of the parameters"

pyghmi/ipmi/console.py

@@ -36,6 +36,7 @@ class Console(object):
     :param iohandler: Either a function to call with bytes, a filehandle to
                       use for input and output, or a tuple of (input, output)
                       handles
+    :param force: Set to True to force on or False to force off
     :param kg: optional parameter for BMCs configured to require it
     """
 

pyghmi/ipmi/events.py

@@ -198,6 +198,7 @@ def decode_eventdata(sensor_type, offset, eventdata, sdr):
     :param sensor_type: The sensor type number from the event
     :param offset:  Sensor specific offset
     :param eventdata: The three bytes from the log or alert
+    :param sdr: The sdr locator entry to help clarify how to parse data
     """
     if sensor_type == 5 and offset == 4:  # link loss, indicates which port
         return 'Port {0}'.format(eventdata[1])
@@ -396,6 +397,7 @@ class EventHandler(object):
     manageable data.
 
     :param sdr: An SDR object (per pyghmi.ipmi.sdr) matching the target BMC SDR
+    :param ipmicmd: An ipmi command object to fetch data live
     """
     def __init__(self, sdr, ipmicmd):
         self._sdr = sdr