djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

bleio: Improve type documentation

Browse Source
This commit is contained in:
arturo182 2018-07-19 20:35:24 +02:00
parent 3bd65fbae5
commit 5412bf66c3
4 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
shared-bindings/bleio/Characteristic.c
View File

@ -43,7 +43,7 @@
//| //|
//| Create a new Characteristic object identified by the specified UUID. //| Create a new Characteristic object identified by the specified UUID.
//| //|
//| :param uuid: The uuid of the characteristic //| :param bleio.UUID uuid: The uuid of the characteristic
//| //|
//| .. attribute:: broadcast //| .. attribute:: broadcast

3
shared-bindings/bleio/Scanner.c
View File

@ -65,8 +65,9 @@
//| .. method:: scan(timeout) //| .. method:: scan(timeout)
//| //|
//| Performs a BLE scan lasting :py:data:`timeout` ms. //| Performs a BLE scan.
//| //|
//| :param int timeout: the scan timeout in ms
//| :returns: advertising packets found //| :returns: advertising packets found
//| :rtype: list of :py:class:`bleio.ScanEntry` //| :rtype: list of :py:class:`bleio.ScanEntry`
//| //|

3
shared-bindings/bleio/Service.c
View File

@ -43,7 +43,8 @@
//| Create a new Service object identified by the specified UUID. //| Create a new Service object identified by the specified UUID.
//| To mark the service as secondary, pass `True` as :py:data:`secondary`. //| To mark the service as secondary, pass `True` as :py:data:`secondary`.
//| //|
//| :param uuid: The uuid of the service //| :param bleio.UUID uuid: The uuid of the service
//| :param bool secondary: If the service is a secondary one
//| //|
//| .. method:: add_characteristic(characteristic) //| .. method:: add_characteristic(characteristic)

2
shared-bindings/bleio/UUID.c
View File

@ -89,7 +89,7 @@ enum {
//| - a `str` value in the format of '0xXXXX' for 16-bit or 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' for 128-bit //| - a `str` value in the format of '0xXXXX' for 16-bit or 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' for 128-bit
//| - another UUID object //| - another UUID object
//| //|
//| :param uuid: The uuid to encapsulate //| :param int/str uuid: The uuid to encapsulate
//| //|
//| .. attribute:: type //| .. attribute:: type