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.

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

Add sub-headings to the "Potential API" explainer section #94

Open
domenic opened this issue Aug 7, 2020 · 0 comments
Open

Add sub-headings to the "Potential API" explainer section #94

domenic opened this issue Aug 7, 2020 · 0 comments

Comments

@domenic
Copy link
Collaborator

domenic commented Aug 7, 2020

The "Potential API" section is great, guiding the reader through various increasingly-complex cases. I think it would benefit from small thematic breaks so that folks could tell when you're switching gears.

In particular I'd imagine:

  • Acquiring and opening a port
  • Writing and reading from a port
  • Reading in a loop (or this could be part of the previous section)
  • Handling non-fatal errors
  • Using transform streams
  • Sending signals (or, perhaps, "Other parts of the port API", and you could expand it to cover getInfo/setSignals/getSignals?)
  • Watching for changes to the port

Other potential enhancements:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant