Skip to content

Commit 9ff9259

Browse files
committed
fix interlinking in busio docs
1 parent 02c7033 commit 9ff9259

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

shared-bindings/busio/I2C.c

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
//| lines respectively.
4747
//|
4848
//| .. 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
5050
//| manage locks.
5151
//|
5252
//| .. seealso:: Using this class to directly read registers requires manual
@@ -56,7 +56,8 @@
5656
//| :param ~microcontroller.Pin scl: The clock pin
5757
//| :param ~microcontroller.Pin sda: The data pin
5858
//| :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`)
6061
//|
6162
//| .. note:: On the nRF52840, only one I2C object may be created,
6263
//| 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
239240
//| to poll for the existence of a device.
240241
//|
241242
//| :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
243244
//| :param int start: Index to start writing from
244245
//| :param int end: Index to read up to but not include. Defaults to ``len(buffer)``"""
245246
//| ...
@@ -286,12 +287,12 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_KW(busio_i2c_writeto_obj, 1, busio_i2c_writeto);
286287
//| bit, generate a repeated start and read into ``in_buffer``. ``out_buffer`` and
287288
//| ``in_buffer`` can be the same buffer because they are used sequentially.
288289
//|
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
290291
//| as if ``buffer[start:end]``. This will not cause an allocation like ``buf[start:end]``
291292
//| will so it saves memory.
292293
//|
293294
//| :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
295296
//| :param ~_typing.WriteableBuffer in_buffer: buffer to write into
296297
//| :param int out_start: Index to start writing from
297298
//| :param int out_end: Index to read up to but not include. Defaults to ``len(buffer)``

shared-bindings/busio/SPI.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
//| peripherals.
6666
//|
6767
//| .. seealso:: Using this class directly requires careful lock management.
68-
//| Instead, use :class:`~adafruit_bus_device.spi_device.SPIDevice` to
68+
//| Instead, use :class:`~adafruit_bus_device.SPIDevice` to
6969
//| manage locks.
7070
//|
7171
//| .. seealso:: Using this class to directly read registers requires manual

0 commit comments

Comments
 (0)