More documentation

JeffLIrion · Sep 16, 2019 · ebedab1 · ebedab1
1 parent b5130b8
commit ebedab1
Showing 1 changed file with 10 additions and 10 deletions.
diff --git a/adb/adb_protocol.py b/adb/adb_protocol.py
@@ -558,7 +558,7 @@ def Send(self, usb, timeout_ms=None):
 
         Parameters
         ----------
-        usb : adb.common.UsbHandle
+        usb : adb.common.TcpHandle, adb.common.UsbHandle
             TODO
         timeout_ms : int, None
             Timeout in milliseconds for USB packets.
@@ -577,7 +577,7 @@ def Read(cls, usb, expected_cmds, timeout_ms=None, total_timeout_ms=None):
 
         Parameters
         ----------
-        usb : adb.common.UsbHandle
+        usb : adb.common.TcpHandle, adb.common.UsbHandle
             TODO
         expected_cmds : TODO
             Read until we receive a header ID that is in ``expected_cmds``
@@ -647,8 +647,8 @@ def Connect(cls, usb, banner=b'notadb', rsa_keys=None, auth_timeout_ms=100):
 
         Parameters
         ----------
-        usb : TODO
-            A USBHandle with ``BulkRead`` and ``BulkWrite`` methods.
+        usb : adb.common.TcpHandle, adb.common.UsbHandle
+            A :class:`adb.common.TcpHandle` or :class:`adb.common.UsbHandle` instance with ``BulkRead`` and ``BulkWrite`` methods.
         banner : str
             A string to send as a host identifier.
         rsa_keys : list[adb_protocol.AuthSigner]
@@ -732,8 +732,8 @@ def Open(cls, usb, destination, timeout_ms=None):
 
         Parameters
         ----------
-        usb : TODO
-            USB device handle with BulkRead and BulkWrite methods.
+        usb : adb.common.TcpHandle, adb.common.UsbHandle
+            A :class:`adb.common.TcpHandle` or :class:`adb.common.UsbHandle` instance with ``BulkRead`` and ``BulkWrite`` methods.
         destination : TODO
             The service:command string.
         timeout_ms : int, None
@@ -784,8 +784,8 @@ def Command(cls, usb, service, command='', timeout_ms=None):
 
         Parameters
         ----------
-        usb : TODO
-            USB device handle with BulkRead and BulkWrite methods.
+        usb : adb.common.TcpHandle, adb.common.UsbHandle
+            A :class:`adb.common.TcpHandle` or :class:`adb.common.UsbHandle` instance with ``BulkRead`` and ``BulkWrite`` methods.
         service : TODO
             The service on the device to talk to.
         command : str
@@ -822,8 +822,8 @@ def StreamingCommand(cls, usb, service, command='', timeout_ms=None):
 
         Parameters
         ----------
-        usb : TODO
-            USB device handle with BulkRead and BulkWrite methods.
+        usb : adb.common.TcpHandle, adb.common.UsbHandle
+            A :class:`adb.common.TcpHandle` or :class:`adb.common.UsbHandle` instance with ``BulkRead`` and ``BulkWrite`` methods.
         service : TODO
             The service on the device to talk to.
         command : str