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

top level examples directory? #3

Open
FoamyGuy opened this issue Dec 3, 2021 · 1 comment
Open

top level examples directory? #3

FoamyGuy opened this issue Dec 3, 2021 · 1 comment

Comments

@FoamyGuy
Copy link
Contributor

FoamyGuy commented Dec 3, 2021

Right now the examples are separated into directories named after the built-in modules that they are illustrating. Some of the pre-commit config is written to assume there will be an examples/ directory. Perhaps it would make the most sense to take the built-in module directories and put them inside of a top level examples/ dir.

We need to verify that the pre-commit config will drill into sub directories though, most circuitpython libraries have their examples directly inside of examples/ and we'll be (at least) one layer deeper in this repo.

@rsbohn
Copy link
Contributor

rsbohn commented Dec 3, 2021

Since the pylint config is different for examples it would make sense to add the folder. If the pre-commit can't handle nested example folders we could just use the examples pylint config as the default for this project.

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

No branches or pull requests

2 participants