Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/drivers.rst does not include import name #462

Closed
dhalbert opened this issue May 24, 2024 · 0 comments · Fixed by #485
Closed

docs/drivers.rst does not include import name #462

dhalbert opened this issue May 24, 2024 · 0 comments · Fixed by #485

Comments

@dhalbert
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant