-
Notifications
You must be signed in to change notification settings - Fork 214
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
Remove more examples. Update doctests. #2547
base: main
Are you sure you want to change the base?
Conversation
2f54c00
to
aad3206
Compare
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 |
I guess since #2558 was merged, I can move part of deleted examples to |
Let's wait for the release to merge this |
5724fc3
to
58358a3
Compare
cc2d29b
to
d4db366
Compare
c3c7170
to
2a4787a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is close to ready, just some final bits to restore/move and it should be good to go!
cde1238
to
f41a2a7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a bunch of unnecessary noise in the doctests, please clean this up. I may have missed some too.
4404e5d
to
0c30815
Compare
I guess in some places there are commented out |
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are still quite a lot of print's that are commented out, we recently added noop println:
Lines 19 to 21 in c1f0c13
# macro_rules! println { | |
# ($($tt:tt)*) => { }; | |
# } |
Feel free to add print!
there too, and then proceed to uncomment the prints
I agree that most aren't needed, but some are. |
Also in a lot of places we now have |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! This is looking good from my side
+ fix psram
upd: revert "is_not_release" check
remove useless feature
remove inappropriate doctest tutorial
f940c86
to
1a43162
Compare
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>