Remove inaccurate code comment #349
Open
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
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.
Remove an inaccurate comment from the code.
Motivation:
The removed comment incorrectly described the
flush()method as not having an effect when the flush mode is set to.always. Not only is this the opposite of the actual behavior, in fact the method itself is not affected by the flush mode at all; that check is made elsewhere. Further, at the point where the check is made, the behavior is clearly spelled out by the code making the check, so moving the comment there seems redundant. As such, it seemed best to simply remove it altogether.Modifications:
Removed a comment.
Result:
The inaccurate comment can no longer cause confusion.