search

esp-rs / esp-hal

no_std Hardware Abstraction Layers for ESP32 microcontrollers
https://docs.esp-rs.org/esp-hal/
Apache License 2.0
764 stars 214 forks source link

Remove more examples. Update doctests. #2547

Open playfulFence opened 1 week ago

playfulFence commented 1 week ago

Description

Moves things forward in terms of #2513. Some examples are still there, part of them will be removed when QA repo/directory is published.

Testing

xtask run-doc-tests esp-hal <chip>

bjoernQ commented 4 days ago

I'd say some of the "examples" which are deleted here should go to qa-test (ideally hil test but most of them cannot) instead of just deleting them.

While it's nice the doc tests compile, we should easily be able to verify those drivers still do what they are supposed to do

playfulFence commented 4 days ago

I guess since https://github.com/esp-rs/esp-hal/pull/2558 was merged, I can move part of deleted examples to qa-test directory now.

MabezDev commented 4 days ago

Let's wait for the release to merge this

bjoernQ commented 4 hours ago

I guess in some places there are commented out println! lines because before that didn't compile - we now have that in the before-snippet so no need to comment out these (but it's println! not esp_println::println!)

playfulFence commented 4 hours ago

I think what @jessebraham meant is that some of those printlns were more of a noise for documentation than a benefit 🤔

I think I agree, probably most of those println made sense in the example but not in the documentation.

MabezDev commented 4 hours ago

I think I agree, probably most of those println made sense in the example but not in the documentation.

I agree that most aren't needed, but some are.

bjoernQ commented 4 hours ago

Also in a lot of places we now have writeln!(serial_tx,"..... which is definitely more noise in examples than println!