Adafruit_CircuitPython_Bundle icon indicating copy to clipboard operation
Adafruit_CircuitPython_Bundle copied to clipboard

docs/drivers.rst does not include import name

Open dhalbert opened this issue 1 year ago • 0 comments

The libraries list in docs/drivers.rst does not visibly include the import name of the library. For instance, if I am looking for the adafruit_esp32spi library documentation, and searching for the string "esp32spi", I won't find it, because the entry is:

ESP32 WiFi Co-Processor over SPI

I think it would be helpful if the entry looked something like one of these instead. The exact formatting is an aesthetic choice.

ESP32 WiFi Co-Processor over SPI (adafruit_esp32spi)

ESP32 WiFi Co-Processor over SPI: adafruit_esp32spi

etc.

This would also help with websearch indexing.

dhalbert avatar May 24 '24 12:05 dhalbert