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.

Sign up for GitHub

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

Jump to bottom

Silently ignore non-doc-comment comments. #1363

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Silently ignore non-doc-comment comments. #1363

wants to merge 2 commits into from

Conversation

sunfishcode
Copy link
Member

As part of #1362, silently ignore comments that aren't /// comments. This won't break any actual code; it just means that documentation comments won't show up in generated bindings unless the /// syntax is used.

All wit files I've seen already use /// syntax for comments, so I expect the impact of this change will be low.

@sunfishcode
Silently ignore non-doc-comment comments.
d1fd637 
As part of #1362, silently ignore comments
that aren't `///` comments. This won't break any actual code; it just
means that documentation comments won't show up in generated bindings
unless the `///` syntax is used.

All wit files I've seen already use `///` syntax for comments, so I
expect the impact of this change will be low.
@sunfishcode
Fix /// whitespace parsing, and fix tests to use /// comments.
508a631
@alexcrichton
Copy link
Member

Given the recent switch to // away from /// and that this is going back, could this be turned off by default for now? Effectively allow either // or /// during this transitionary period with an env var to force // to get ignored

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sunfishcode @alexcrichton