Skip to content

Commit 514d414

Browse files
committed
Fix sphinx warnings.
1 parent d8a4f71 commit 514d414

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

shared-bindings/bleio/Central.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,16 @@ STATIC mp_obj_t bleio_central_make_new(const mp_obj_type_t *type, size_t n_args,
8686
//|
8787
//| :param bleio.Address address: The address of the peripheral to connect to
8888
//| :param float/int timeout: Try to connect for timeout seconds.
89-
//| :param iterable service_uuids: a collection of `UUID` objects for the services
89+
//| :param iterable service_uuids: a collection of :py:class:~`UUID` objects for the services
9090
//| provided by the peripheral that you want to use.
9191
//| The peripheral may provide more services, but services not listed are ignored.
92-
//| If a service in `service_uuids` is not found during discovery, it will not
92+
//| If a service in service_uuids is not found during discovery, it will not
9393
//| appear in `remote_services`.
9494
//|
95-
//| If `services` is None, then all services will undergo discovery, which can be slow.
95+
//| If service_uuids is None, then all services will undergo discovery, which can be slow.
9696
//|
9797
//| If the service UUID is 128-bit, or its characteristic UUID's are 128-bit, you
98-
//| you must have already created a `UUID` object for that UUID in order for the
98+
//| you must have already created a :py:class:~`UUID` object for that UUID in order for the
9999
//| service or characteristic to be discovered. (This restriction may be lifted in the future.)
100100
//|
101101
STATIC mp_obj_t bleio_central_connect(mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {

shared-bindings/bleio/Scanner.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ STATIC mp_obj_t bleio_scanner_make_new(const mp_obj_type_t *type, size_t n_args,
7373
//| :param float timeout: the scan timeout in seconds
7474
//| :param float interval: the interval (in seconds) between the start of two consecutive scan windows
7575
//| Must be in the range 0.0025 - 40.959375 seconds.
76-
//| :param float window: the duration (in seconds) to scan a single BLE channel
77-
//| `window` must be <= `interval`.
76+
//| :param float window: the duration (in seconds) to scan a single BLE channel.
77+
//| window must be <= interval.
7878
//| :returns: advertising packets found
7979
//| :rtype: list of :py:class:`bleio.ScanEntry`
8080
//|

0 commit comments

Comments
 (0)