|
46 | 46 | //| lines respectively.
|
47 | 47 | //|
|
48 | 48 | //| .. seealso:: Using this class directly requires careful lock management.
|
49 |
| -//| Instead, use :class:`~adafruit_bus_device.i2c_device.I2CDevice` to |
| 49 | +//| Instead, use :class:`~adafruit_bus_device.I2CDevice` to |
50 | 50 | //| manage locks.
|
51 | 51 | //|
|
52 | 52 | //| .. seealso:: Using this class to directly read registers requires manual
|
|
56 | 56 | //| :param ~microcontroller.Pin scl: The clock pin
|
57 | 57 | //| :param ~microcontroller.Pin sda: The data pin
|
58 | 58 | //| :param int frequency: The clock frequency in Hertz
|
59 |
| -//| :param int timeout: The maximum clock stretching timeut - (used only for bitbangio.I2C; ignored for busio.I2C) |
| 59 | +//| :param int timeout: The maximum clock stretching timeut - (used only for |
| 60 | +//| :class:`bitbangio.I2C`; ignored for :class:`busio.I2C`) |
60 | 61 | //|
|
61 | 62 | //| .. note:: On the nRF52840, only one I2C object may be created,
|
62 | 63 | //| except on the Circuit Playground Bluefruit, which allows two,
|
@@ -239,7 +240,7 @@ MP_DEFINE_CONST_FUN_OBJ_KW(busio_i2c_readfrom_into_obj, 3, busio_i2c_readfrom_in
|
239 | 240 | //| to poll for the existence of a device.
|
240 | 241 | //|
|
241 | 242 | //| :param int address: 7-bit device address
|
242 |
| -//| :param ~_typing.ReadbleBuffer buffer: buffer containing the bytes to write |
| 243 | +//| :param ~_typing.ReadableBuffer buffer: buffer containing the bytes to write |
243 | 244 | //| :param int start: Index to start writing from
|
244 | 245 | //| :param int end: Index to read up to but not include. Defaults to ``len(buffer)``"""
|
245 | 246 | //| ...
|
@@ -286,12 +287,12 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_KW(busio_i2c_writeto_obj, 1, busio_i2c_writeto);
|
286 | 287 | //| bit, generate a repeated start and read into ``in_buffer``. ``out_buffer`` and
|
287 | 288 | //| ``in_buffer`` can be the same buffer because they are used sequentially.
|
288 | 289 | //|
|
289 |
| -//| if ``start`` or ``end`` is provided, then the corresponding buffer will be sliced |
| 290 | +//| If ``start`` or ``end`` is provided, then the corresponding buffer will be sliced |
290 | 291 | //| as if ``buffer[start:end]``. This will not cause an allocation like ``buf[start:end]``
|
291 | 292 | //| will so it saves memory.
|
292 | 293 | //|
|
293 | 294 | //| :param int address: 7-bit device address
|
294 |
| -//| :param ~_typing.ReadbleBuffer out_buffer: buffer containing the bytes to write |
| 295 | +//| :param ~_typing.ReadableBuffer out_buffer: buffer containing the bytes to write |
295 | 296 | //| :param ~_typing.WriteableBuffer in_buffer: buffer to write into
|
296 | 297 | //| :param int out_start: Index to start writing from
|
297 | 298 | //| :param int out_end: Index to read up to but not include. Defaults to ``len(buffer)``
|
|
0 commit comments