Skip to content

Cleaned examples up#44

Merged
EGJ-Moorington merged 5 commits intodevfrom
43-clean-examples-up
Jan 26, 2026
Merged

Cleaned examples up#44
EGJ-Moorington merged 5 commits intodevfrom
43-clean-examples-up

Conversation

@EGJ-Moorington
Copy link
Copy Markdown
Owner

Cleaned examples up by:

  • Changing file names.
  • Removing unused imports.
  • Adding a short description of the example in each of the files' docstring.
  • Creating a simpler two button set-up usage example.
  • Improving the readme-example-updater pre-commit hook to raise a warning when a non-existent file is included in README.rst.
  • Fixing the readme-example-updater pre-commit hook to trigger when examples are updated.

Closes #43

Fixed `readme-example-updater` `pre-commit` hook to trigger when examples are updated.
Improved the `readme-example-updater` `pre-commit` hook to raise a warning when including non-existent example files in `README.rst`.
Cleaned examples up by removing unused imports, adding docstrings, renaming files for better readability and adding a simpler example for double button set-ups.
@EGJ-Moorington EGJ-Moorington added this to the Version 3.0.3 milestone Jan 26, 2026
@EGJ-Moorington EGJ-Moorington self-assigned this Jan 26, 2026
@EGJ-Moorington EGJ-Moorington added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Jan 26, 2026
@github-actions
Copy link
Copy Markdown

👋 Thanks for this pull request! Unfortunately, it looks like the automated continuous integration (CI) test(s) failed. These can be tricky to fix so we've written a guide on how to fix them locally. It has pages about running pre-commit locally and another about building the docs locally with sphinx. Thanks for contributing to CircuitPython! If you have more questions, feel free to join the Adafruit Discord and post in #circuitpython-dev.

Reverted `examples/button_handler_simpletest.py` rename so that `pytest` does not test it.
Updated docs to use the new example paths and include the new exmple.
@EGJ-Moorington EGJ-Moorington merged commit 0d760c3 into dev Jan 26, 2026
2 checks passed
@EGJ-Moorington EGJ-Moorington deleted the 43-clean-examples-up branch January 26, 2026 17:51
EGJ-Moorington added a commit that referenced this pull request Jan 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant