Skip to content

Fix port-support lists and other documentation - #11926

Merged
tannewt merged 2 commits into
adafruit:mainfrom
dhalbert:doc-fixes
Nov 20, 2026
Merged

tannewt merged 2 commits into
adafruit:mainfrom
dhalbert:doc-fixes

Conversation

@dhalbert

@dhalbert dhalbert commented Nov 19, 2026 •

Copy link
Copy Markdown
Collaborator

I had Claude take a survey of port-support docstrings and doc-only issues, and fix them. Edits by Claude, reviewed by @dhalbert.

Port-support lists

Several **Limitations:** docstrings were incomplete, or listed the wrong ports or chips. Each list was checked against the ports' common-hal code and CIRCUITPY_* settings. Generally, the docs now list where a feature is available rather than where it is not, unless the list would be too long.

Corrected:

  • rtc.RTC.calibration
  • alarm.touch.TouchAlarm
  • analogio.AnalogOut
  • busio.UART RS485
  • microcontroller.Processor.temperature
  • wifi.Radio.mac_address and mac_address_ap
  • RP2040-only notes that also apply to RP2350 now say RP2xxx

busio.I2C and busio.SPI locks

Added a warning to try_lock(): release the lock promptly, and prefer adafruit_bus_device's I2CDevice and SPIDevice. On Espressif, holding a lock for a long time while using WiFi can starve the WiFi and USB tasks, so the board may hang or restart in safe mode (#10561).

errno

The errno page now lists the errno codes in most builds and the smaller set in SAMD21 builds. It also says that most SAMD21 boards, including all SAMD21 boards without external flash, do not include errno, and points to the Module Support Matrix. Code comments next to both lists in py/moderrno.c and ports/atmel-samd/mpconfigport.h say to update errno.rst when the lists change.

busio.I2C.probe() and scan() on Zephyr nRF boards

Added a limitation note to both: on Zephyr-based nRF boards, they do not work reliably at 400 kHz, so use 100 kHz. See #11604.

Fix Limitations docstrings that left out ports or chips or named the
wrong ones, and list where a feature is available where practical.
Change RP2040-only notes that also apply to RP2350 to say RP2xxx.

Warn against holding busio I2C and SPI locks for a long time, which
can starve WiFi and USB on Espressif.

Document which errno codes are available on which builds, with code
comments next to the errno lists pointing to errno.rst.

Fixes adafruit#11877.
Fixes adafruit#10561.
Fixes adafruit#9737.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dhalbert
dhalbert requested a review from a team November 19, 2026 21:37
On Zephyr-based nRF boards, a NACKed zero-length write can end the
next transfer early when the bus runs at 400 kHz, so probe() and scan()
can give wrong results. The cause is in nrfx; see adafruit#11604.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@tannewt tannewt left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, thanks!

@tannewt
tannewt merged commit 55b6339 into adafruit:main Nov 20, 2026
712 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants