Add more code comments #984
Merged
+148
−13
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
| @@ -4,6 +4,7 @@ import {getStartTime} from '../return/duration.js'; | |||
| import {joinCommand} from './escape.js'; | |||
| import {normalizeFdSpecificOption} from './specific.js'; | |||
|
|
|||
| // Compute `result.command`, `result.escapedCommand` and `verbose`-related information | |||
There was a problem hiding this comment.
Maybe standardize with . at the end? Some comments have it and some don't.
There was a problem hiding this comment.
Currently the comments do not use periods when there is a single sentence, and use periods otherwise.
Would you prefer to always using periods, even when there is a single sentence?
There was a problem hiding this comment.
It's not a big deal. Just felt a bit inconsistent.
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.
This PR adds more code comments, to make it easier for contributors.