Add a section on vertical space #227
Merged
Conversation
This file contains hidden or 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
Co-authored-by: Michael Chirico <[email protected]>
|
|
||
| * Avoid empty lines at the start or end of functions. | ||
| * Only use a single empty line when needed to separate functions or pipes. | ||
| * It often makes sense to put an empty line before a comment block, to help visually connect the explanation with the code that it applies to. |
There was a problem hiding this comment.
My read is this implies "When a comment block is the first thing in a function body, a blank line is OK". Makes sense to me, but we may want to iterate the wording if that's not the intention.
MichaelChirico
approved these changes
Sep 30, 2024
5 tasks
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.
@MichaelChirico how does this look to you?
Fixes #185.