Switch to /// for printing documentation comments.
#1357
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Per the discussion in WebAssembly/component-model#286, switch to `///` for documentation comments in the Wit printer. `//` comments are still accepted and interpreted as documentation comments for now.
alexcrichton
approved these changes
Jan 5, 2024
Member
alexcrichton
left a comment
alexcrichton
left a comment
There was a problem hiding this comment.
Thanks!
Would you be up for implementing a warning as well for usage of //? It's not something we would enable just yet by default but it'd be good to go ahead and get the code in so it can be opted-in to if desired.
3 tasks
yamt
added a commit
to yamt/wasi-sensor-discussion
that referenced
this pull request
Jan 12, 2024
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
yamt
added a commit
to midokura/wasi-sensor-discussion
that referenced
this pull request
Jan 17, 2024
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Switch to
///for printing documentation comments.Per the discussion in WebAssembly/component-model#286, switch to
///for documentation comments in the Wit printer.
//comments are still accepted and interpreted as documentationcomments for now.
And update the copy of wasi-http in the tests, to a newer version that uses
///doc comments.