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

Include import names in the library list #418

Open
dhalbert opened this issue Dec 9, 2022 · 1 comment
Open

Include import names in the library list #418

dhalbert opened this issue Dec 9, 2022 · 1 comment

Comments

@dhalbert
Copy link
Contributor

dhalbert commented Dec 9, 2022

Currently, the library names in https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/docs/drivers.rst are all descriptive names and do not include the actual library names that one would use in an import: adafruit_whatever, neopixel, asyncio, etc. This was already noted in #342 when the adafruit_hid library could not be found by searching for "HID".

As part of #344, or just manually, it would be nice to include these import names in the list, so that it would be easy to search for them.

@jposada202020
Copy link
Contributor

Maybe we could do this in the following steps:

  1. Modify the contents of drivers.rst with the correct import name, and maybe a description as was done for the community libraries as per Adding Drivers Libraries Descriptions CircuitPython_Community_Bundle#132.
  2. Once drivers.rst is updated we change the name to libraries.rst as per "Drivers" vs "Helpers" is not so helpful as a top-level distinction #419
    Let me know thanks :)

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

No branches or pull requests

2 participants