[stdlib] Tweak comments #693
Closed
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
| @@ -80,7 +80,7 @@ internal func _parseAsciiAsUIntMax( | |||
| else { return nil } | |||
| // Disallow < 0. | |||
| if hasMinus && result != 0 { return nil } | |||
| // Return. | |||
| // Valid result, return. | |||
| return result | |||
| } | |||
There was a problem hiding this comment.
IMO all of these return comments are vacuous and should be deleted
There was a problem hiding this comment.
@dabrahams I can definitely see where you're coming from but let me explain myself :).
Rationale
The comments headings are intended for code grouping (instead of newlines) so you can quickly skim the algorithm and it's structure/flow just from those headings. The return here doesn't belong to the // Disallow < 0 code. You could separate them with a newline, but a comment is a bit more consistent with the rest of the method, and while skimming the headings conveys the fact that we early-returned all invalid results.
|
I agree with DaveA here, I'd prefer that these vacuous comments just be removed. |
Merged
freak4pc
pushed a commit
to freak4pc/swift
that referenced
this pull request
Sep 28, 2022
Pass the default process timeout from the main process to the subprocesses that build the projects
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.
Slight amendment to #613 to, among others, replace a
// Returncomment with something a bit more useful :).