Minor docs fixes in displayio.Bitmap

This commit is contained in:
James Carr 2021-04-23 12:56:44 +01:00
parent 8f73270f2b
commit 07059dd373
No known key found for this signature in database
GPG Key ID: 14665603BA81F181

View File

@ -45,11 +45,11 @@
//| the bitmap data is packed into the memoryview with unspecified padding. //| the bitmap data is packed into the memoryview with unspecified padding.
//| //|
//| A Bitmap can be treated as a buffer, allowing its content to be //| A Bitmap can be treated as a buffer, allowing its content to be
//| viewed and modified using e.g., with ``ulab.numpy.frombuffer``, //| viewed and modified using e.g., with `ulab.numpy.frombuffer`,
//| but the `displayio.Bitmap.dirty` method must be used to inform //| but the `displayio.Bitmap.dirty` method must be used to inform
//| displayio when a bitmap was modified through the buffer interface. //| displayio when a bitmap was modified through the buffer interface.
//| //|
//| `bitmaptools.arrayblit` can also be useful to omve data efficiently //| `bitmaptools.arrayblit` can also be useful to move data efficiently
//| into a Bitmap. //| into a Bitmap.
//| """ //| """
//| //|
@ -125,7 +125,7 @@ const mp_obj_property_t displayio_bitmap_height_obj = {
//| def __getitem__(self, index: Union[Tuple[int, int], int]) -> int: //| def __getitem__(self, index: Union[Tuple[int, int], int]) -> int:
//| """Returns the value at the given index. The index can either be an x,y tuple or an int equal //| """Returns the value at the given index. The index can either be an x,y tuple or an int equal
//| to ``y * width + x``. //| to `y * width + x`.
//| //|
//| This allows you to:: //| This allows you to::
//| //|
@ -134,7 +134,7 @@ const mp_obj_property_t displayio_bitmap_height_obj = {
//| //|
//| def __setitem__(self, index: Union[Tuple[int, int], int], value: int) -> None: //| def __setitem__(self, index: Union[Tuple[int, int], int], value: int) -> None:
//| """Sets the value at the given index. The index can either be an x,y tuple or an int equal //| """Sets the value at the given index. The index can either be an x,y tuple or an int equal
//| to ``y * width + x``. //| to `y * width + x`.
//| //|
//| This allows you to:: //| This allows you to::
//| //|