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

Make sure all documentation examples build and run #24

Open
mjhouse opened this issue Feb 28, 2023 · 3 comments
Open

Make sure all documentation examples build and run #24

mjhouse opened this issue Feb 28, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@mjhouse
Copy link
Owner

mjhouse commented Feb 28, 2023

I'm not sure that they do, currently.

@mjhouse mjhouse added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 28, 2023
@vcrn
Copy link
Contributor

vcrn commented Mar 1, 2023

I suppose this issue more concerns manually checking that the examples do run when copy-pasted to a main.rs, but this library looks quite interesting for testing: https://github.com/dbrgn/embedded-hal-mock

I guess we could see if we can get some actual testing in place using that lib, if it seems useful.

@mjhouse
Copy link
Owner Author

mjhouse commented Mar 1, 2023

Oh yeah. Sorry, this was drive-by issue. I didn't think of the fact that you would need hardware to run the doc tests. I may take a stab with the mocking lib at some point in the next few days.

@mjhouse mjhouse removed the good first issue Good for newcomers label Mar 1, 2023
@mjhouse
Copy link
Owner Author

mjhouse commented Mar 1, 2023

I removed the good first issue tag, since this is going to be somewhat involved, and created #25 to investigate mocking for doc tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants