diff options
| author | Jason Neal <jason.neal@astro.up.pt> | 2020-01-11 19:44:17 +1300 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2020-01-12 13:44:59 +1100 |
| commit | 7ef2f65114f092be6303c145a2560fdf522dcde0 (patch) | |
| tree | 52ea36a8dc03bc5e6a4b0b4b332a5c8d784d8a39 /docs/library/ubluetooth.rst | |
| parent | 6632dd3981cbdca8e70c0bf19e36338101e9ce0e (diff) | |
docs/library: Add / to indicate positional-only args in library docs.
Removes the confusion of positional-only arguments which have defaults that
look like keyword arguments.
Diffstat (limited to 'docs/library/ubluetooth.rst')
| -rw-r--r-- | docs/library/ubluetooth.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/library/ubluetooth.rst b/docs/library/ubluetooth.rst index 1a62d1e4b..e3f4e1382 100644 --- a/docs/library/ubluetooth.rst +++ b/docs/library/ubluetooth.rst @@ -268,7 +268,7 @@ writes from a central to a given characteristic, use of the notification, avoiding the need for a separate read request. Note that this will not update the local value stored. -.. method:: BLE.gatts_set_buffer(value_handle, len, append=False) +.. method:: BLE.gatts_set_buffer(value_handle, len, append=False, /) Sets the internal buffer size for a value in bytes. This will limit the largest possible write that can be received. The default is 20. @@ -283,7 +283,7 @@ writes from a central to a given characteristic, use Central Role (GATT Client) -------------------------- -.. method:: BLE.gap_connect(addr_type, addr, scan_duration_ms=2000) +.. method:: BLE.gap_connect(addr_type, addr, scan_duration_ms=2000, /) Connect to a peripheral. @@ -326,7 +326,7 @@ Central Role (GATT Client) On success, the ``_IRQ_GATTC_READ_RESULT`` event will be raised. -.. method:: BLE.gattc_write(conn_handle, value_handle, data, mode=0) +.. method:: BLE.gattc_write(conn_handle, value_handle, data, mode=0, /) Issue a remote write to a connected peripheral for the specified characteristic or descriptor handle. |