Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-07-28 04:07:46 +00:00
Code Issues Releases Activity

pybricks.messaging: Fix a few minor typos in docstrings.

Browse Source 
A few docstrings contained spelling and grammar mistakes. These changes improve readability and do not affect functionality.
This commit is contained in:
Bert
2026-06-27 11:17:32 -05:00
committed by David Lechner
parent d17b40796c
commit 7e79c20f7d
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/pybricks/messaging.py
+4 -4
View File
@@ -182,7 +182,7 @@ class Mailbox(Generic[T]):
You can read data that is delivered by other EV3 bricks, or send data You can read data that is delivered by other EV3 bricks, or send data
to other bricks that have the same mailbox. to other bricks that have the same mailbox.
By default, the mailbox reads and send only bytes. To send other By default, the mailbox reads and sends only bytes. To send other
data, you can provide an ``encode`` function that encodes your Python data, you can provide an ``encode`` function that encodes your Python
object into bytes, and a ``decode`` function to convert bytes back to object into bytes, and a ``decode`` function to convert bytes back to
a Python object. a Python object.
@@ -217,7 +217,7 @@ class Mailbox(Generic[T]):
value: value:
The value that will be delivered to the mailbox. The value that will be delivered to the mailbox.
brick (str): brick (str):
The name or Bluetooth address of the brick or ``None`` to The name or Bluetooth address of the brick or ``None``
to broadcast to all connected devices. to broadcast to all connected devices.
Raises: Raises:
@@ -228,7 +228,7 @@ class Mailbox(Generic[T]):
def wait(self) -> None: def wait(self) -> None:
"""wait() """wait()
Waits for the mailbox to be updated by remote device.""" Waits for the mailbox to be updated by a remote device."""
def wait_new(self) -> T: def wait_new(self) -> T:
"""wait_new() """wait_new()
@@ -380,7 +380,7 @@ class AppData:
Bluetooth. This is used by the smart sensor features like the vision Bluetooth. This is used by the smart sensor features like the vision
processors. processors.
Each processor has on emode and produces a fixed amount of data. These are Each processor has one mode and produces a fixed amount of data. These are
continuously sent to the hub as they change. The user code can read these continuously sent to the hub as they change. The user code can read these
buffered values at any time without blocking. All values are initially zero. buffered values at any time without blocking. All values are initially zero.