Skip to content

Commit 32a29ff

Browse files
jeplerjepler
committed
shared-bindings: Change docstrings with '\x...' chars to raw strings
Closes: adafruit#3032
1 parent cb8539b commit 32a29ff

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

‎shared-bindings/_bleio/Address.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ STATIC mp_obj_t bleio_address_make_new(const mp_obj_type_t *type, size_t n_args,
7878
}
7979

8080
//| address_bytes: Any = ...
81-
//| """The bytes that make up the device address (read-only).
81+
//| r"""The bytes that make up the device address (read-only).
8282
//|
8383
//| Note that the ``bytes`` object returned is in little-endian order:
8484
//| The least significant byte is ``address_bytes[0]``. So the address will

‎shared-bindings/displayio/Display.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
//| contain the initialization sequence at minimum."""
5151
//|
5252
//| def __init__(self, display_bus: Any, init_sequence: buffer, *, width: int, height: int, colstart: int = 0, rowstart: int = 0, rotation: int = 0, color_depth: int = 16, grayscale: bool = False, pixels_in_byte_share_row: bool = True, bytes_per_cell: int = 1, reverse_pixels_in_byte: bool = False, set_column_command: int = 0x2a, set_row_command: int = 0x2b, write_ram_command: int = 0x2c, set_vertical_scroll: int = 0, backlight_pin: microcontroller.Pin = None, brightness_command: int = None, brightness: bool = 1.0, auto_brightness: bool = False, single_byte_bounds: bool = False, data_as_commands: bool = False, auto_refresh: bool = True, native_frames_per_second: int = 60):
53-
//| """Create a Display object on the given display bus (`displayio.FourWire` or `displayio.ParallelBus`).
53+
//| r"""Create a Display object on the given display bus (`displayio.FourWire` or `displayio.ParallelBus`).
5454
//|
5555
//| The ``init_sequence`` is bitpacked to minimize the ram impact. Every command begins with a
5656
//| command byte followed by a byte to determine the parameter count and if a delay is need after.

‎shared-bindings/displayio/Palette.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ STATIC mp_obj_t group_unary_op(mp_unary_op_t op, mp_obj_t self_in) {
8585
}
8686

8787
//| def __setitem__(self, index: Any, value: Any) -> Any:
88-
//| """Sets the pixel color at the given index. The index should be an integer in the range 0 to color_count-1.
88+
//| r"""Sets the pixel color at the given index. The index should be an integer in the range 0 to color_count-1.
8989
//|
9090
//| The value argument represents a color, and can be from 0x000000 to 0xFFFFFF (to represent an RGB value).
9191
//| Value can be an int, bytes (3 bytes (RGB) or 4 bytes (RGB + pad byte)), bytearray,

‎shared-bindings/nvm/ByteArray.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
#include "supervisor/shared/translate.h"
3333

3434
//| class ByteArray:
35-
//| """Presents a stretch of non-volatile memory as a bytearray.
35+
//| r"""Presents a stretch of non-volatile memory as a bytearray.
3636
//|
3737
//| Non-volatile memory is available as a byte array that persists over reloads
3838
//| and power cycles. Each assignment causes an erase and write cycle so its recommended to assign

0 commit comments

Comments
 (0)