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.

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

Jump to bottom

io: expand docs. #469

Merged
merged 1 commit into from
Jul 12, 2023
Merged

io: expand docs. #469

merged 1 commit into from
Jul 12, 2023

Conversation

Dirbaio
Copy link
Member

@Dirbaio 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 Dirbaio requested a review from a team as a code owner July 12, 2023 13:04
eldruin
eldruin approved these changes Jul 12, 2023
View reviewed changes
Copy link
Member

@eldruin eldruin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks!

@eldruin eldruin added this pull request to the merge queue Jul 12, 2023
Merged via the queue into master with commit 27be7bc Jul 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eldruin eldruin eldruin approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Dirbaio @eldruin