Skip to content

Commit 02c7033

Browse files
authored
fix I2CDevice docs
1 parent dc02f97 commit 02c7033

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

shared-bindings/adafruit_bus_device/I2CDevice.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
//|
4747
//| """Represents a single I2C device and manages locking the bus and the device
4848
//| address.
49+
//|
4950
//| :param ~busio.I2C i2c: The I2C bus the device is on
5051
//| :param int device_address: The 7 bit device address
5152
//| :param bool probe: Probe for the device upon object creation, default is true
@@ -114,6 +115,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(adafruit_bus_device_i2cdevice___exit_
114115
//| If ``start`` or ``end`` is provided, then the buffer will be sliced
115116
//| as if ``buf[start:end]``. This will not cause an allocation like
116117
//| ``buf[start:end]`` will so it saves memory.
118+
//|
117119
//| :param bytearray buf: buffer to write into
118120
//| :param int start: Index to start writing at
119121
//| :param int end: Index to write up to but not include; if None, use ``len(buf)``"""
@@ -157,6 +159,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_KW(adafruit_bus_device_i2cdevice_readinto_obj, 2,
157159
//| If ``start`` or ``end`` is provided, then the buffer will be sliced
158160
//| as if ``buffer[start:end]``. This will not cause an allocation like
159161
//| ``buffer[start:end]`` will so it saves memory.
162+
//|
160163
//| :param bytearray buf: buffer containing the bytes to write
161164
//| :param int start: Index to start writing from
162165
//| :param int end: Index to read up to but not include; if None, use ``len(buf)``
@@ -208,6 +211,7 @@ MP_DEFINE_CONST_FUN_OBJ_KW(adafruit_bus_device_i2cdevice_write_obj, 2, adafruit_
208211
//| will be sliced as if ``in_buffer[in_start:in_end]``. This will not
209212
//| cause an allocation like ``in_buffer[in_start:in_end]`` will so
210213
//| it saves memory.
214+
//|
211215
//| :param bytearray out_buffer: buffer containing the bytes to write
212216
//| :param bytearray in_buffer: buffer containing the bytes to read into
213217
//| :param int out_start: Index to start writing from

0 commit comments

Comments
 (0)