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

// in continuation lines aren't reported as problems #129

Open
dduan opened this issue Dec 20, 2019 · 1 comment
Open

// in continuation lines aren't reported as problems #129

dduan opened this issue Dec 20, 2019 · 1 comment
Labels
enhancement New feature or request

Comments

@dduan
Copy link
Owner

dduan commented Dec 20, 2019

/// blah blah blah
// <- notice how there are 2 `/`s

This should be a problem and be autoformattable.

@dduan dduan added the enhancement New feature or request label Dec 30, 2019
@mattt
Copy link

mattt commented Jan 30, 2020

Huh, I hadn't considered this as a possibility. The contract for how to interpret discontiguous doc comment lines seems under-specified, and now that's got me thinking about what the right way to handle it would be...

If it's a typo, then we'd ideally want to auto-correct, or maybe just generate a warning.

What if it was intentional, though? A normal comment between doc comments has the same effect as commenting out code, so someone could use this as a clever way to annotate doc comments. In that case, I think any attempt to resituate it would be destructive.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants