-
Notifications
You must be signed in to change notification settings - Fork 221
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
Add rule to "add space between '//' and beginning of comment" #552
Comments
|
@HassanTaleb90 @allevato, in some situations for structured comments (DocC) format does affect how they would parse and get processed. Wrong formatting of a doc comment might result in broken documentation. That would be a different rule from the one @ErciliaR suggests here. There must've been another discussion on this that I missed — feel free to "well actually" and link me to it! I wonder, how do we make decisions about adding rules? They're optional, so in theory, we can provide a rule that enforces one and only one space between |
I assumed that this issue is presumably about non-documentation comments, so at the risk of digressing... For documentation comments, users should be authoring valid Markdown. Period. If the comment is structurally valid, then rewrapping it using the However, I'm not sure how opinionated we want to be about documentation comments. We already use the It all depends on how prescriptive we want to be with the markup choices and how flexible those APIs are. |
Tracked in Apple’s issue tracker as rdar://126948292 |
The text was updated successfully, but these errors were encountered: