Skip to content

Commit 5412bf6

Browse files
committed
bleio: Improve type documentation
1 parent 3bd65fb commit 5412bf6

File tree

4 files changed

+6
-4
lines changed

4 files changed

+6
-4
lines changed

shared-bindings/bleio/Characteristic.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
//|
4444
//| Create a new Characteristic object identified by the specified UUID.
4545
//|
46-
//| :param uuid: The uuid of the characteristic
46+
//| :param bleio.UUID uuid: The uuid of the characteristic
4747
//|
4848

4949
//| .. attribute:: broadcast

shared-bindings/bleio/Scanner.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,9 @@
6565

6666
//| .. method:: scan(timeout)
6767
//|
68-
//| Performs a BLE scan lasting :py:data:`timeout` ms.
68+
//| Performs a BLE scan.
6969
//|
70+
//| :param int timeout: the scan timeout in ms
7071
//| :returns: advertising packets found
7172
//| :rtype: list of :py:class:`bleio.ScanEntry`
7273
//|

shared-bindings/bleio/Service.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@
4343
//| Create a new Service object identified by the specified UUID.
4444
//| To mark the service as secondary, pass `True` as :py:data:`secondary`.
4545
//|
46-
//| :param uuid: The uuid of the service
46+
//| :param bleio.UUID uuid: The uuid of the service
47+
//| :param bool secondary: If the service is a secondary one
4748
//|
4849

4950
//| .. method:: add_characteristic(characteristic)

shared-bindings/bleio/UUID.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ enum {
8989
//| - a `str` value in the format of '0xXXXX' for 16-bit or 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' for 128-bit
9090
//| - another UUID object
9191
//|
92-
//| :param uuid: The uuid to encapsulate
92+
//| :param int/str uuid: The uuid to encapsulate
9393
//|
9494

9595
//| .. attribute:: type

0 commit comments

Comments
 (0)