From cfe24b85322a029758c3376eed2726657397bf33 Mon Sep 17 00:00:00 2001
From: Scott Shawcroft <scott@tannewt.org>
Date: Thu, 30 May 2019 19:01:27 -0700
Subject: Improve rST consistency for rst2pyi use

---
 shared-bindings/busio/I2C.c | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

(limited to 'shared-bindings/busio/I2C.c')

diff --git a/shared-bindings/busio/I2C.c b/shared-bindings/busio/I2C.c
index e17a72b48..1c50c07b0 100644
--- a/shared-bindings/busio/I2C.c
+++ b/shared-bindings/busio/I2C.c
@@ -41,7 +41,7 @@
 //| :class:`I2C` --- Two wire serial protocol
 //| ------------------------------------------
 //|
-//| .. class:: I2C(scl, sda, \*, frequency=400000)
+//| .. class:: I2C(scl, sda, *, frequency=400000, timeout=255)
 //|
 //|   I2C is a two-wire protocol for communicating between devices.  At the
 //|   physical level it consists of 2 wires: SCL and SDA, the clock and data
@@ -82,7 +82,7 @@ STATIC mp_obj_t busio_i2c_make_new(const mp_obj_type_t *type, size_t n_args, con
     return (mp_obj_t)self;
 }
 
-//|   .. method:: I2C.deinit()
+//|   .. method:: deinit()
 //|
 //|     Releases control of the underlying hardware so other classes can use it.
 //|
@@ -93,13 +93,13 @@ STATIC mp_obj_t busio_i2c_obj_deinit(mp_obj_t self_in) {
 }
 MP_DEFINE_CONST_FUN_OBJ_1(busio_i2c_deinit_obj, busio_i2c_obj_deinit);
 
-//|   .. method:: I2C.__enter__()
+//|   .. method:: __enter__()
 //|
 //|     No-op used in Context Managers.
 //|
 //  Provided by context manager helper.
 
-//|   .. method:: I2C.__exit__()
+//|   .. method:: __exit__()
 //|
 //|     Automatically deinitializes the hardware on context exit. See
 //|     :ref:`lifetime-and-contextmanagers` for more info.
@@ -118,7 +118,7 @@ static void check_lock(busio_i2c_obj_t *self) {
     }
 }
 
-//|   .. method:: I2C.scan()
+//|   .. method:: scan()
 //|
 //|      Scan all I2C addresses between 0x08 and 0x77 inclusive and return a
 //|      list of those that respond.
@@ -142,7 +142,7 @@ STATIC mp_obj_t busio_i2c_scan(mp_obj_t self_in) {
 }
 MP_DEFINE_CONST_FUN_OBJ_1(busio_i2c_scan_obj, busio_i2c_scan);
 
-//|   .. method:: I2C.try_lock()
+//|   .. method:: try_lock()
 //|
 //|     Attempts to grab the I2C lock. Returns True on success.
 //|
@@ -156,7 +156,7 @@ STATIC mp_obj_t busio_i2c_obj_try_lock(mp_obj_t self_in) {
 }
 MP_DEFINE_CONST_FUN_OBJ_1(busio_i2c_try_lock_obj, busio_i2c_obj_try_lock);
 
-//|   .. method:: I2C.unlock()
+//|   .. method:: unlock()
 //|
 //|     Releases the I2C lock.
 //|
@@ -168,7 +168,7 @@ STATIC mp_obj_t busio_i2c_obj_unlock(mp_obj_t self_in) {
 }
 MP_DEFINE_CONST_FUN_OBJ_1(busio_i2c_unlock_obj, busio_i2c_obj_unlock);
 
-//|   .. method:: I2C.readfrom_into(address, buffer, \*, start=0, end=len(buffer))
+//|   .. method:: readfrom_into(address, buffer, *, start=0, end=None)
 //|
 //|      Read into ``buffer`` from the slave specified by ``address``.
 //|      The number of bytes read will be the length of ``buffer``.
@@ -181,7 +181,7 @@ MP_DEFINE_CONST_FUN_OBJ_1(busio_i2c_unlock_obj, busio_i2c_obj_unlock);
 //|      :param int address: 7-bit device address
 //|      :param bytearray buffer: buffer to write into
 //|      :param int start: Index to start writing at
-//|      :param int end: Index to write up to but not include
+//|      :param int end: Index to write up to but not include. Defaults to ``len(buffer)``
 //|
 STATIC mp_obj_t busio_i2c_readfrom_into(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_address, ARG_buffer, ARG_start, ARG_end };
@@ -216,7 +216,7 @@ STATIC mp_obj_t busio_i2c_readfrom_into(size_t n_args, const mp_obj_t *pos_args,
 }
 MP_DEFINE_CONST_FUN_OBJ_KW(busio_i2c_readfrom_into_obj, 3, busio_i2c_readfrom_into);
 
-//|   .. method:: I2C.writeto(address, buffer, \*, start=0, end=len(buffer), stop=True)
+//|   .. method:: writeto(address, buffer, *, start=0, end=None, stop=True)
 //|
 //|      Write the bytes from ``buffer`` to the slave specified by ``address``.
 //|      Transmits a stop bit if ``stop`` is set.
@@ -231,7 +231,7 @@ MP_DEFINE_CONST_FUN_OBJ_KW(busio_i2c_readfrom_into_obj, 3, busio_i2c_readfrom_in
 //|      :param int address: 7-bit device address
 //|      :param bytearray buffer: buffer containing the bytes to write
 //|      :param int start: Index to start writing from
-//|      :param int end: Index to read up to but not include
+//|      :param int end: Index to read up to but not include. Defaults to ``len(buffer)``
 //|      :param bool stop: If true, output an I2C stop condition after the
 //|                        buffer is written
 //|
-- 
cgit v1.2.3