Merge branch 'master' into patch-1

Signed-off-by: Ben Wynn <bwynn@glowie.com>

Author: benwynn

.github/workflows/codespell.yml

@@ -0,0 +1,13 @@
+name: Check spelling with codespell
+
+on: [push, pull_request]
+
+jobs:
+  codespell:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v5
+    # codespell version should be kept in sync with .pre-commit-config.yml
+    - run: pip install --user codespell==2.4.1 tomli
+    - run: codespell
+

.pre-commit-config.yaml

@@ -13,3 +13,11 @@ repos:
     hooks:
       - id: ruff
         id: ruff-format
+
+  - repo: https://github.com/codespell-project/codespell
+    # version should be kept in sync with .github/workflows/codespell.yml & micropython repo
+    rev: v2.4.1
+    hooks:
+    - id: codespell
+      additional_dependencies:
+        - tomli

CONTRIBUTING.md

@@ -87,6 +87,40 @@ specific conventions and guidelines for micropython-lib:
   packages](README.md#installing-packages-from-forks) in your Pull Request
   description.
 
+### Module documentation
+
+Each package in micropython-lib is encouraged to include documentation in
+the form of docstrings in the code itself. The top-level docstring in the main
+module or package should provide an overview of the package's functionality,
+usage examples, and any important notes or caveats.
+
+Note that the docstrings should be concise and relevant, even though they will
+not be included in the cross-compiled bytecode and will not impact the size of
+the module when installed via `mip`.
+
+When writing docstrings, please follow these guidelines:
+* Use triple double quotes (`"""`) for docstrings.
+* Multi-line docstrings should place the starting and ending triple quotes on
+  their own lines.
+* Start with a brief summary of the module's purpose.
+* Include usage examples where appropriate (indent examplecode blocks with 4
+  spaces).
+* Use proper indentation for multi-line docstrings to align with the code block.
+
+### Module versioning
+
+Each package in micropython-lib should include a `manifest.py` file that
+specifies metadata about the package, including its version. The version
+management is intentionally manual to ensure package stability and prevent
+accidental version bumps. When making changes to a package that affect its
+functionality or API, please update the version in `manifest.py`. The
+`tools/build.py` script will detect new versions and add them to the index, but
+won't increment versions automatically
+
+> [!NOTE]
+> Changes to docstrings or comments that do not change the generated bytecode
+> should not change the version.
+
 ### Publishing packages from forks
 
 You can easily publish the packages from your micropython-lib

micropython/aiorepl/aiorepl.py

@@ -74,7 +74,7 @@ async def kbd_intr_task(exec_task, s):
                 except asyncio.CancelledError:
                     pass
         else:
-            # Excute code snippet directly.
+            # Execute code snippet directly.
             try:
                 try:
                     micropython.kbd_intr(3)

micropython/bluetooth/aioble/README.md

@@ -93,7 +93,7 @@ async with aioble.scan(duration_ms=5000, interval_us=30000, window_us=30000, act
 # Either from scan result
 device = result.device
 # Or with known address
-device = aioble.Device(aioble.PUBLIC, "aa:bb:cc:dd:ee:ff")
+device = aioble.Device(aioble.ADDR_PUBLIC, "aa:bb:cc:dd:ee:ff")
 
 try:
     connection = await device.connect(timeout_ms=2000)

micropython/bluetooth/aioble/aioble/central.py

@@ -119,7 +119,7 @@ async def _connect(
     _connecting.add(device)
 
     # Event will be set in the connected IRQ, and then later
-    # re-used to notify disconnection.
+    # reused to notify disconnection.
     connection._event = connection._event or asyncio.ThreadSafeFlag()
 
     try:

micropython/bluetooth/aioble/aioble/client.py

@@ -244,7 +244,7 @@ async def read(self, timeout_ms=1000):
         self._register_with_connection()
         # This will be set by the done IRQ.
         self._read_status = None
-        # This will be set by the result and done IRQs. Re-use if possible.
+        # This will be set by the result and done IRQs. Reuse if possible.
         self._read_event = self._read_event or asyncio.ThreadSafeFlag()
 
         # Issue the read.

micropython/bluetooth/aioble/examples/l2cap_file_server.py

@@ -1,7 +1,7 @@
 # MIT license; Copyright (c) 2021 Jim Mussared
 
 # This is a BLE file server, based very loosely on the Object Transfer Service
-# specification. It demonstrated transfering data over an L2CAP channel, as
+# specification. It demonstrated transferring data over an L2CAP channel, as
 # well as using notifications and GATT writes on a characteristic.
 
 # The server supports downloading and uploading files, as well as querying
@@ -33,7 +33,7 @@
 _CONTROL_CHARACTERISTIC_UUID = bluetooth.UUID("0492fcec-7194-11eb-9439-0242ac130003")
 
 # How frequently to send advertising beacons.
-_ADV_INTERVAL_MS = 250_000
+_ADV_INTERVAL_US = 250_000
 
 
 _COMMAND_SEND = const(0)
@@ -162,7 +162,7 @@ async def peripheral_task():
     while True:
         print("Waiting for connection")
         connection = await aioble.advertise(
-            _ADV_INTERVAL_MS,
+            _ADV_INTERVAL_US,
             name="mpy-file",
             services=[_FILE_SERVICE_UUID],
         )

micropython/bluetooth/aioble/examples/temp_sensor.py

@@ -20,7 +20,7 @@
 _ADV_APPEARANCE_GENERIC_THERMOMETER = const(768)
 
 # How frequently to send advertising beacons.
-_ADV_INTERVAL_MS = 250_000
+_ADV_INTERVAL_US = 250_000
 
 
 # Register GATT server.
@@ -50,7 +50,7 @@ async def sensor_task():
 async def peripheral_task():
     while True:
         async with await aioble.advertise(
-            _ADV_INTERVAL_MS,
+            _ADV_INTERVAL_US,
             name="mpy-temp",
             services=[_ENV_SENSE_UUID],
             appearance=_ADV_APPEARANCE_GENERIC_THERMOMETER,

micropython/drivers/display/lcd160cr/lcd160cr.py

@@ -56,7 +56,7 @@ def __init__(self, connect=None, *, pwr=None, i2c=None, spi=None, i2c_addr=98):
             pwr(1)
             sleep_ms(10)
         # else:
-        # alread have power
+        # already have power
         # lets be optimistic...
 
         # set connections