Adding comment to testing.expectEqualStrings #25825
Closed
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
Author
|
My first contribution to a project of this size. Picked something non-important. Hopefully working towards more meaningful contributions in the future. |
|
Incorrect English, states obvious things that can be inferred from name of function and reading return values. Doc comments are for non-obvious explanations. Source code is available in the docs. Duplicate PR #25828 |
Author
|
I have improved the comment based on your review. Doc comments are also a user friendly version of the type signature that is used on hover by a lot of IDEAs. Various other functions in that file have obvious explanations as well. I’m trying to follow the style of the other comments. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.