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

De-duplicate and generally improve examples #1436

Closed
jessebraham opened this issue Apr 15, 2024 · 1 comment · Fixed by #1590
Closed

De-duplicate and generally improve examples #1436

jessebraham opened this issue Apr 15, 2024 · 1 comment · Fixed by #1590
Assignees
Labels
examples There is a problem with one or more of the examples status:needs-attention This should be prioritized

Comments

@jessebraham
Copy link
Member

Prior to HIL testing, our examples were serving a dual purpose, both demonstrating use of the HAL and testing/verifying the functionality. With HIL testing now available, we should focus our examples on using the hardware, not proving out the drivers.

There are also a number of examples specific to third-party trait packages, e.g. all the eh1_ prefixed examples. We should rework our examples to demonstrate only the applicable driver(s), the trait packages should be irrelevant here.

Additionally, we should try to better comment and just generally improve examples as able.

@jessebraham jessebraham added the examples There is a problem with one or more of the examples label Apr 15, 2024
@bjoernQ
Copy link
Contributor

bjoernQ commented Apr 16, 2024

... and just generally improve examples as able

I think some of the examples are really tests (especially the crypto-accelerators but also others). These are better turned into HIL tests. (But t.b.h. I can't imagine how an interesting example of using a crypto-accelerator might look like)

Some tests could be more interesting if there would be some console output

@jessebraham jessebraham added the status:needs-attention This should be prioritized label Apr 24, 2024
@MabezDev MabezDev self-assigned this May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples There is a problem with one or more of the examples status:needs-attention This should be prioritized
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants