search

mjhouse / ag-lcd

A rust port of the C++ LiquidCrystal library for arduino systems
GNU General Public License v3.0
17 stars 8 forks source link

Make sure all documentation examples build and run #24

Open mjhouse opened 1 year ago

mjhouse commented 1 year ago

I'm not sure that they do, currently.

vcrn commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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