Skip to content

The colors provided by adafruit_led_animation.color are not documented #71

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

Closed
siddacious opened this issue Nov 27, 2020 · 4 comments · Fixed by #73
Closed

The colors provided by adafruit_led_animation.color are not documented #71

siddacious opened this issue Nov 27, 2020 · 4 comments · Fixed by #73
Assignees

Comments

@siddacious
Copy link

Several colors are used in examples, however the full list is not available anywhere other than in the code.

It would be great if these could be documented so users know what is available to use.

@tannewt
Copy link
Member

tannewt commented Nov 30, 2020

I think they'd appear in ReadTheDocs if they had """ """ comments afterwards.

@johnwargo
Copy link

They're all listed in this file: https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation/blob/master/adafruit_led_animation/color.py

Sure, the list could be in the docs, but this is open source, so its really easy to find the code that defines the colors.

@siddacious
Copy link
Author

@johnwargo Yes, one could just read the code but we're trying to make this accessible to people who are still learning and for whom reading code doesn't come as easily as those with more experience.

@kattni
Copy link
Contributor

kattni commented Dec 8, 2020

I thought I had documented them in the guide - I did not. That needs to be rectified regardless of updating the API documentation.

That said, I will look into getting them to show up in the API documentation as well. I noticed this two weeks ago when working on a guide where the code allowed for updating colors, and I realised they weren't listed in the docs.

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.

4 participants