summaryrefslogtreecommitdiff
path: root/shared-bindings
diff options
context:
space:
mode:
authorScott Shawcroft <scott@adafruit.com>2020-06-16 11:49:27 -0700
committerGitHub <noreply@github.com>2020-06-16 11:49:27 -0700
commita345223dac6a58f4437cbbbfc28468ebb4b3237a (patch)
tree4d151e7a625fe8da05d3cc8017a3d9e500c1a485 /shared-bindings
parentdffac11c2fccb6c0ca859a38f7649e13ccdc9081 (diff)
parent7a51719fa287a1a45af6d411c7a698cb6c20aedb (diff)
Merge pull request #3031 from jepler/improve-shared-bindings-links
docs: Improve 5.0.x <-> main branch doc linkrot
Diffstat (limited to 'shared-bindings')
-rw-r--r--shared-bindings/_bleio/Address.c2
-rw-r--r--shared-bindings/displayio/Display.c2
-rw-r--r--shared-bindings/displayio/Palette.c2
-rw-r--r--shared-bindings/index.rst2
-rw-r--r--shared-bindings/nvm/ByteArray.c2
5 files changed, 5 insertions, 5 deletions
diff --git a/shared-bindings/_bleio/Address.c b/shared-bindings/_bleio/Address.c
index ccbab1b9d..9beaff2ab 100644
--- a/shared-bindings/_bleio/Address.c
+++ b/shared-bindings/_bleio/Address.c
@@ -78,7 +78,7 @@ STATIC mp_obj_t bleio_address_make_new(const mp_obj_type_t *type, size_t n_args,
}
//| address_bytes: Any = ...
-//| """The bytes that make up the device address (read-only).
+//| r"""The bytes that make up the device address (read-only).
//|
//| Note that the ``bytes`` object returned is in little-endian order:
//| The least significant byte is ``address_bytes[0]``. So the address will
diff --git a/shared-bindings/displayio/Display.c b/shared-bindings/displayio/Display.c
index 62ef0f5d0..6e454f34b 100644
--- a/shared-bindings/displayio/Display.c
+++ b/shared-bindings/displayio/Display.c
@@ -50,7 +50,7 @@
//| contain the initialization sequence at minimum."""
//|
//| 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):
-//| """Create a Display object on the given display bus (`displayio.FourWire` or `displayio.ParallelBus`).
+//| r"""Create a Display object on the given display bus (`displayio.FourWire` or `displayio.ParallelBus`).
//|
//| The ``init_sequence`` is bitpacked to minimize the ram impact. Every command begins with a
//| command byte followed by a byte to determine the parameter count and if a delay is need after.
diff --git a/shared-bindings/displayio/Palette.c b/shared-bindings/displayio/Palette.c
index 871b2b06a..37cfbd82e 100644
--- a/shared-bindings/displayio/Palette.c
+++ b/shared-bindings/displayio/Palette.c
@@ -85,7 +85,7 @@ STATIC mp_obj_t group_unary_op(mp_unary_op_t op, mp_obj_t self_in) {
}
//| def __setitem__(self, index: Any, value: Any) -> Any:
-//| """Sets the pixel color at the given index. The index should be an integer in the range 0 to color_count-1.
+//| r"""Sets the pixel color at the given index. The index should be an integer in the range 0 to color_count-1.
//|
//| The value argument represents a color, and can be from 0x000000 to 0xFFFFFF (to represent an RGB value).
//| Value can be an int, bytes (3 bytes (RGB) or 4 bytes (RGB + pad byte)), bytearray,
diff --git a/shared-bindings/index.rst b/shared-bindings/index.rst
index d94177394..bf04ae18b 100644
--- a/shared-bindings/index.rst
+++ b/shared-bindings/index.rst
@@ -19,5 +19,5 @@ Modules
:glob:
:maxdepth: 2
- ../autoapi/*/index
+ ../shared-bindings/*/index
help
diff --git a/shared-bindings/nvm/ByteArray.c b/shared-bindings/nvm/ByteArray.c
index 326f719a8..06d7d4c95 100644
--- a/shared-bindings/nvm/ByteArray.c
+++ b/shared-bindings/nvm/ByteArray.c
@@ -32,7 +32,7 @@
#include "supervisor/shared/translate.h"
//| class ByteArray:
-//| """Presents a stretch of non-volatile memory as a bytearray.
+//| r"""Presents a stretch of non-volatile memory as a bytearray.
//|
//| Non-volatile memory is available as a byte array that persists over reloads
//| and power cycles. Each assignment causes an erase and write cycle so its recommended to assign