bytecodealliance / bytecodealliance/wasm-tools
wit: migrate to only accepting `///` for doc comments
Open
component-model
wit
- Dominant language
- Rust
- Stars
- 1.8k
- Forks
- 351
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 46
Description
Per the discussion in https://github.com/WebAssembly/component-model/issues/286, there seems to be consensus for using `///` as the documentation comment syntax.
This syntax is already recognized, so the plan for using `///` is:
- [x] Update the Wit printer to use it. https://github.com/bytecodealliance/wasm-tools/pull/1357
- [ ] After some time, add a deprecation warning for // comments pointing uses to ///.
- [ ] After some time, make the warning an error.
Contributor guide
Assessment
This issue has not been assessed yet.