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

Add animations examples #9

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

HundredVisionsGuy
Copy link

NOTE: this pull request is in draft state, so you can provide any feedback before I add any more documentation.

So far, I've added two additional sections to examples.rst:

For the LED Animations Functions section, I've included the first two of twelve so you can see what I'm thinking of doing for each function. My thought is to include the following for each animation function:

  • name of the function,
  • include a brief description,
  • provide a code snippet showing how to import and call the function
  • list the parameters (both required and default parameters).

Please let me know if you have any questions or concerns with the path I'm taking.

@HundredVisionsGuy
Copy link
Author

Sorry, I forgot to initialize pre-commit. I will do that and fix the trailing whitespace error.

@tekktrik
Copy link
Member

Hi! Thanks for the submission. Is this ready for review?

@HundredVisionsGuy
Copy link
Author

HundredVisionsGuy commented Jul 29, 2023

If you like what I've done so far, my plan was to include similar code samples and explanations for the remaining LED animation functions.

Would you like me to add the other LED animation functions to the documentation?

@tekktrik
Copy link
Member

Sure! Just say whenever its ready - I just wanted to make sure it wasn't accidentally marked as draft and therefore accidentally ignored.

@tekktrik
Copy link
Member

My recommendation would be to add your code, comments, and documentation as working Python files in the examples/ folder so that people can readily add them to their device. Having working examples files they can immediately use and begin tweaking will help them better understand the functionalities.

@HundredVisionsGuy
Copy link
Author

HundredVisionsGuy commented Jul 31, 2023 via email

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 this pull request may close these issues.

None yet

2 participants