Skip to content

Commit

Permalink
Comment changes (#77)
Browse files Browse the repository at this point in the history
* comment typos

* error comment: another approach

I wasn't able to parse the error comment. Could just be me.
  • Loading branch information
FrankReh authored Apr 29, 2024
1 parent 324be89 commit cc5ea50
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 9 deletions.
2 changes: 1 addition & 1 deletion imports.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ wasi-clocks API to the list.</p>
<p>This function does not return a <code>result</code>; polling in itself does not
do any I/O so it doesn't fail. If any of the I/O sources identified by
the pollables has an error, it is indicated by marking the source as
being reaedy for I/O.</p>
being ready for I/O.</p>
<h5>Params</h5>
<ul>
<li><a name="poll.in"><code>in</code></a>: list&lt;borrow&lt;<a href="#pollable"><a href="#pollable"><code>pollable</code></a></a>&gt;&gt;</li>
Expand Down
12 changes: 5 additions & 7 deletions wit/error.wit
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,11 @@ interface error {
/// `wasi:io/streams/stream-error` type.
///
/// To provide more specific error information, other interfaces may
/// provide functions to further "downcast" this error into more specific
/// error information. For example, `error`s returned in streams derived
/// from filesystem types to be described using the filesystem's own
/// error-code type, using the function
/// `wasi:filesystem/types/filesystem-error-code`, which takes a parameter
/// `borrow<error>` and returns
/// `option<wasi:filesystem/types/error-code>`.
/// offer functions to "downcast" this error into more specific types. For example,
/// errors returned from streams derived from filesystem types can be described using
/// the filesystem's own error-code type. This is done using the function
/// `wasi:filesystem/types/filesystem-error-code`, which takes a `borrow<error>`
/// parameter and returns an `option<wasi:filesystem/types/error-code>`.
///
/// The set of functions which can "downcast" an `error` into a more
/// concrete type is open.
Expand Down
2 changes: 1 addition & 1 deletion wit/poll.wit
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ interface poll {
/// This function does not return a `result`; polling in itself does not
/// do any I/O so it doesn't fail. If any of the I/O sources identified by
/// the pollables has an error, it is indicated by marking the source as
/// being reaedy for I/O.
/// being ready for I/O.
poll: func(in: list<borrow<pollable>>) -> list<u32>;
}

0 comments on commit cc5ea50

Please sign in to comment.