Skip to content

Commit

Permalink
wit: retire non-doc comments
Browse files Browse the repository at this point in the history
wit-parser 1.3.1 contains a breaking change [1], which
made our CI fail with "found doc comments on multiple 'package' items".
(i guess they should not have made such a breaking change in
a patch version.)

as the wit spec is going to retire non-doc comments,
this commit retires all non-doc comments in our wit files.
(either by removing them or switching them to doc comments.)

[1] bytecodealliance/wasm-tools#1357
  • Loading branch information
yamt committed Jan 17, 2024
1 parent 125cd91 commit 15937f8
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 8 deletions.
2 changes: 1 addition & 1 deletion wit/sensor.wit
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ interface sensor {
unknown
}

// Sensor device
/// Sensor device
resource device {
/// open the device.
/// this might power on the device.
Expand Down
7 changes: 0 additions & 7 deletions wit/world.wit
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
// If the repository defines `interface`s, this file can define a minimal world
// which contains those interfaces, to allow documentation to be generated for
// them.
//
// Proposals should remove these `//` commments, and edit the `world` name and
// imports below to pull in their own `interface`s.

package wasi:sensor;

world sensing {
Expand Down

0 comments on commit 15937f8

Please sign in to comment.