Skip to content

Commit c415c13

Browse files
committed
mend broken doc block
Since black_bindings.py will pass each contiguous "//|"-block to black independently, they must each be a fully formed Python item.
1 parent da4f2db commit c415c13

File tree

7 files changed

+4
-9
lines changed

7 files changed

+4
-9
lines changed

shared-bindings/bitbangio/I2C.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_KW(bitbangio_i2c_writeto_obj, 1, bitbangio_i2c_wr
288288
//| If ``in_start`` or ``in_end`` is provided, then the input buffer will be sliced
289289
//| as if ``in_buffer[in_start:in_end]`` were passed,
290290
//| The number of bytes read will be the length of ``out_buffer[in_start:in_end]``.
291-
291+
//|
292292
//| :param int address: 7-bit device address
293293
//| :param ~circuitpython_typing.ReadableBuffer out_buffer: buffer containing the bytes to write
294294
//| :param ~circuitpython_typing.WriteableBuffer in_buffer: buffer to write into

shared-bindings/busio/I2C.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_KW(busio_i2c_writeto_obj, 1, busio_i2c_writeto);
289289
//| If ``in_start`` or ``in_end`` is provided, then the input buffer will be sliced
290290
//| as if ``in_buffer[in_start:in_end]`` were passed,
291291
//| The number of bytes read will be the length of ``out_buffer[in_start:in_end]``.
292-
292+
//|
293293
//| :param int address: 7-bit device address
294294
//| :param ~circuitpython_typing.ReadableBuffer out_buffer: buffer containing the bytes to write
295295
//| :param ~circuitpython_typing.WriteableBuffer in_buffer: buffer to write into

shared-bindings/frequencyio/__init__.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@
3838
//| .. warning:: This module is not available in SAMD21 builds. See the
3939
//| :ref:`module-support-matrix` for more info.
4040
//|
41-
4241
//| All classes change hardware state and should be deinitialized when they
4342
//| are no longer needed if the program continues after use. To do so, either
4443
//| call :py:meth:`!deinit` or use a context manager. See

shared-bindings/ps2io/__init__.c

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,9 @@
3737
//|
3838
//| The `ps2io` module contains classes to provide PS/2 communication.
3939
//|
40-
4140
//| .. warning:: This module is not available in some SAMD21 builds. See the
4241
//| :ref:`module-support-matrix` for more info.
4342
//|
44-
4543
//| All classes change hardware state and should be deinitialized when they
4644
//| are no longer needed if the program continues after use. To do so, either
4745
//| call :py:meth:`!deinit` or use a context manager. See

shared-bindings/pwmio/__init__.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@
3737
//|
3838
//| The `pwmio` module contains classes to provide access to basic pulse IO.
3939
//|
40-
4140
//| All classes change hardware state and should be deinitialized when they
4241
//| are no longer needed if the program continues after use. To do so, either
4342
//| call :py:meth:`!deinit` or use a context manager. See

shared-bindings/storage/__init__.c

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,12 @@
4141
//| unmounting which is typically handled by the operating system hosting Python.
4242
//| CircuitPython does not have an OS, so this module provides this functionality
4343
//| directly.
44-
44+
//|
4545
//| For more information regarding using the `storage` module, refer to the `CircuitPython
4646
//| Essentials Learn guide
4747
//| <https://learn.adafruit.com/circuitpython-essentials/circuitpython-storage>`_.
4848
//| """
4949
//|
50-
5150
//| def mount(filesystem: VfsFat, mount_path: str, *, readonly: bool = False) -> None:
5251
//| """Mounts the given filesystem object at the given path.
5352
//|

shared-bindings/supervisor/__init__.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ MP_DEFINE_CONST_FUN_OBJ_2(supervisor_reset_terminal_obj, supervisor_reset_termin
309309
//| characters. Any omitted arguments will be left at their default values.
310310
//|
311311
//| This method must be called in boot.py to have any effect.
312-
312+
//|
313313
//| Not available on boards without native USB support.
314314
//| """
315315
//| ...

0 commit comments

Comments
 (0)