-
Notifications
You must be signed in to change notification settings - Fork 263
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
Cull examples #2513
Comments
I'll also add that if a driver does not have adequate documentation to demonstrate initialization and use of the peripheral, but this is all the example is doing, we should just update the relevant documentation and then purge the example :) |
Is the thinking here that any new drivers introduced don't need to have examples, as long as they have docs describing basic usage and at least one HIL test, then it's fine to land? (I have a specific PR in mind and I'm trying to figure out if the example is basic or not) |
We discussed this a bit today, we should move "examples" that are actually manual tests (not something we can test in HIL, like displays) into their own project/directory.
If it's #2415, we'd probably need one of those manual tests for this (that we can run on the official espressif devkit). |
I'll start sorting through the examples a little by little. |
Closed via #2547, we'll need to work more on examples in the future, but culling these useless ones has been a good start! |
The examples have grown beyond what is maintainable. Whilst longer term, we will want to move to a more "project" based list of examples, we can improve what we have here by culling useless ones.
I think if the following criteria is met, we can remove the example:
hil-test
The text was updated successfully, but these errors were encountered: