Comments #95
Merged
Comments #95
Conversation
This file contains 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
steveklabnik
approved these changes
Sep 13, 2017
guide/guide.md
Outdated
|
|
||
| Prefer line comments (`//`) to block comments (`/* ... */`). | ||
|
|
||
| When using line comments there should be a single space the opening sigil. |
There was a problem hiding this comment.
i'm guessing this is missing an "after"
guide/guide.md
Outdated
|
|
||
| Source lines which are entirely a comment should be limited to 80 characters | ||
| (including comment sigils) in length or the maximum width of the line, whichever | ||
| is smaller: |
There was a problem hiding this comment.
The language here is technically inconsistent with the examples shown below. Assuming the word "length" refers to the total length of the line, including indentation, it suggests that lines with comments should be wrapped exactly at the 80 column mark rather than 80 columns plus the amount of indentation. Hence, it should read something like
Source lines which are entirely a comment should be limited to 80 characters (including comment sigils) in length plus the width of any leading indentation or the maximum width of the line, whichever is smaller:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
closes #17
cc #89