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.

Sign up for GitHub

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

io: expand docs. #469

Merged

eldruin merged 1 commit into master from io-docs

Jul 12, 2023

Member

Dirbaio commented Jul 12, 2023

depends on #466

Document semantics of methods, no more "read std::io docs".
Document differences from std::io
- Error is an associated type now
- std::io might be blocking or nonblocking, embedded-io is always blocking.
Document gotchas with ReadReady/WriteReady usage.
Document cancel-side-effect-free-ness on async.

Dirbaio requested a review from a team as a code owner

July 12, 2023 13:04


io: expand docs.

b55faf9

Dirbaio force-pushed the io-docs branch from a641536 to b55faf9 Compare

July 12, 2023 15:42

eldruin approved these changes

View reviewed changes

Member

eldruin left a comment

Nice, thanks!

eldruin added this pull request to the merge queue

Merged via the queue into master with commit 27be7bc

22 checks passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment