Skip to content

Commit

Permalink
doc(wasi) Improve documentation of WasiVersion::Latest.
Browse files Browse the repository at this point in the history
  • Loading branch information
Hywan committed Dec 4, 2019
1 parent c916f0e commit c12dd85
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion lib/wasi/src/utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,17 @@ pub enum WasiVersion {
Snapshot0,
/// `wasi_snapshot_preview1`.
Snapshot1,
/// Latest version (for the moment, an alias to `Snapshot1`).

/// Latest version.
///
/// It's a “floating” version, i.e. it's an alias to the latest
/// version (for the moment, `Snapshot1`). Using this version is a
/// way to ensure that modules will run only if they come with the
/// latest WASI version (in case of security issues for instance),
/// by just updating the runtime.
///
/// Note that this version is never returned by an API. It is
/// provided only by the user.
Latest,
}

Expand Down

0 comments on commit c12dd85

Please sign in to comment.