From 514d4146d3bf786fe6c582a645e305e709b618ad Mon Sep 17 00:00:00 2001 From: Dan Halbert Date: Thu, 11 Jul 2019 18:23:45 -0400 Subject: [PATCH] Fix sphinx warnings. --- shared-bindings/bleio/Central.c | 8 ++++---- shared-bindings/bleio/Scanner.c | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/shared-bindings/bleio/Central.c b/shared-bindings/bleio/Central.c index 95ba19dd0b..a21f711af7 100644 --- a/shared-bindings/bleio/Central.c +++ b/shared-bindings/bleio/Central.c @@ -86,16 +86,16 @@ STATIC mp_obj_t bleio_central_make_new(const mp_obj_type_t *type, size_t n_args, //| //| :param bleio.Address address: The address of the peripheral to connect to //| :param float/int timeout: Try to connect for timeout seconds. -//| :param iterable service_uuids: a collection of `UUID` objects for the services +//| :param iterable service_uuids: a collection of :py:class:~`UUID` objects for the services //| provided by the peripheral that you want to use. //| The peripheral may provide more services, but services not listed are ignored. -//| If a service in `service_uuids` is not found during discovery, it will not +//| If a service in service_uuids is not found during discovery, it will not //| appear in `remote_services`. //| -//| If `services` is None, then all services will undergo discovery, which can be slow. +//| If service_uuids is None, then all services will undergo discovery, which can be slow. //| //| If the service UUID is 128-bit, or its characteristic UUID's are 128-bit, you -//| you must have already created a `UUID` object for that UUID in order for the +//| you must have already created a :py:class:~`UUID` object for that UUID in order for the //| service or characteristic to be discovered. (This restriction may be lifted in the future.) //| STATIC mp_obj_t bleio_central_connect(mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) { diff --git a/shared-bindings/bleio/Scanner.c b/shared-bindings/bleio/Scanner.c index d50f69fc5b..79ab34931e 100644 --- a/shared-bindings/bleio/Scanner.c +++ b/shared-bindings/bleio/Scanner.c @@ -73,8 +73,8 @@ STATIC mp_obj_t bleio_scanner_make_new(const mp_obj_type_t *type, size_t n_args, //| :param float timeout: the scan timeout in seconds //| :param float interval: the interval (in seconds) between the start of two consecutive scan windows //| Must be in the range 0.0025 - 40.959375 seconds. -//| :param float window: the duration (in seconds) to scan a single BLE channel -//| `window` must be <= `interval`. +//| :param float window: the duration (in seconds) to scan a single BLE channel. +//| window must be <= interval. //| :returns: advertising packets found //| :rtype: list of :py:class:`bleio.ScanEntry` //|