From 15937f821345af358d9476721d64ac6cad16a6fe Mon Sep 17 00:00:00 2001 From: YAMAMOTO Takashi Date: Fri, 12 Jan 2024 14:38:00 +0900 Subject: [PATCH] wit: retire non-doc comments 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] https://github.com/bytecodealliance/wasm-tools/pull/1357 --- wit/sensor.wit | 2 +- wit/world.wit | 7 ------- 2 files changed, 1 insertion(+), 8 deletions(-) diff --git a/wit/sensor.wit b/wit/sensor.wit index 5454ba0..b638b2a 100644 --- a/wit/sensor.wit +++ b/wit/sensor.wit @@ -22,7 +22,7 @@ interface sensor { unknown } - // Sensor device + /// Sensor device resource device { /// open the device. /// this might power on the device. diff --git a/wit/world.wit b/wit/world.wit index 758f9a5..af9a577 100644 --- a/wit/world.wit +++ b/wit/world.wit @@ -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 {