Skip to content

Commit

Permalink
Comment adjustments (WebAssembly#63)
Browse files Browse the repository at this point in the history
* comment sentence structure

* remove redundancy in comment
  • Loading branch information
FrankReh authored Apr 29, 2024
1 parent 8d875df commit 6cfb0f8
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ WASI Clocks is a WASI API for reading the current time and measuring elapsed
time.

Unlike many clock APIs, WASI Clocks is capability-oriented. Instead
of having functions that implicitly reference a clock, WASI clocks' APIs are
of having functions that implicitly reference a clock, WASI Clocks' APIs are
passed a clock handle.

### Goals
Expand Down
7 changes: 3 additions & 4 deletions imports.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ corresponding to a clock tick.</p>
</ul>
<h4><a name="subscribe_instant"><code>subscribe-instant: func</code></a></h4>
<p>Create a <a href="#pollable"><code>pollable</code></a> which will resolve once the specified instant
occured.</p>
has occurred.</p>
<h5>Params</h5>
<ul>
<li><a name="subscribe_instant.when"><code>when</code></a>: <a href="#instant"><a href="#instant"><code>instant</code></a></a></li>
Expand All @@ -108,9 +108,8 @@ occured.</p>
<li><a name="subscribe_instant.0"></a> own&lt;<a href="#pollable"><a href="#pollable"><code>pollable</code></a></a>&gt;</li>
</ul>
<h4><a name="subscribe_duration"><code>subscribe-duration: func</code></a></h4>
<p>Create a <a href="#pollable"><code>pollable</code></a> which will resolve once the given duration has
elapsed, starting at the time at which this function was called.
occured.</p>
<p>Create a <a href="#pollable"><code>pollable</code></a> that will resolve after the specified duration has
elapsed from the time this function is invoked.</p>
<h5>Params</h5>
<ul>
<li><a name="subscribe_duration.when"><code>when</code></a>: <a href="#duration"><a href="#duration"><code>duration</code></a></a></li>
Expand Down
9 changes: 3 additions & 6 deletions wit/monotonic-clock.wit
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ package wasi:[email protected];
///
/// A monotonic clock is a clock which has an unspecified initial value, and
/// successive reads of the clock will produce non-decreasing values.
///
/// It is intended for measuring elapsed time.
interface monotonic-clock {
use wasi:io/poll@0.2.0.{pollable};

Expand All @@ -31,14 +29,13 @@ interface monotonic-clock {
resolution: func() -> duration;

/// Create a `pollable` which will resolve once the specified instant
/// occured.
/// has occurred.
subscribe-instant: func(
when: instant,
) -> pollable;

/// Create a `pollable` which will resolve once the given duration has
/// elapsed, starting at the time at which this function was called.
/// occured.
/// Create a `pollable` that will resolve after the specified duration has
/// elapsed from the time this function is invoked.
subscribe-duration: func(
when: duration,
) -> pollable;
Expand Down

0 comments on commit 6cfb0f8

Please sign in to comment.