Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove doc-comment from WIT.md #281

Merged
merged 1 commit into from
Dec 5, 2023
Merged

Remove doc-comment from WIT.md #281

merged 1 commit into from
Dec 5, 2023

Conversation

lukewagner
Copy link
Member

As discussed in #273, this PR just removes the doc-comment production from WIT.md. (In case you were wondering, I didn't forget to remove uses of doc-comment; it just wasn't referenced anywhere that I could see.)

alexcrichton added a commit to alexcrichton/wasm-tools that referenced this pull request Dec 5, 2023
This updates `wit-parser` to account for WebAssembly/component-model#281.
Doc comments are now considered to be all forms of comments and are
collected in the `Docs` structure. The structure already stripped all
leading `/` characters so it works for either `///` or `//`.
Additionally docs are now printed with `//` instead of `///`.
@alexcrichton
Copy link
Collaborator

I've opened bytecodealliance/wasm-tools#1313 for the tooling side of this

@lukewagner
Copy link
Member Author

Great! Given overall agreement here and in #273, I'll go ahead and merge now.

@lukewagner lukewagner merged commit 9cda856 into main Dec 5, 2023
2 checks passed
@lukewagner lukewagner deleted the one-type-of-comment branch December 5, 2023 23:27
alexcrichton added a commit to bytecodealliance/wasm-tools that referenced this pull request Dec 6, 2023
* Parse and print `//`-style comments as docs

This updates `wit-parser` to account for WebAssembly/component-model#281.
Doc comments are now considered to be all forms of comments and are
collected in the `Docs` structure. The structure already stripped all
leading `/` characters so it works for either `///` or `//`.
Additionally docs are now printed with `//` instead of `///`.

* Update test expectations
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants