docs: Add doc comments to std.math.isNan#25822
Open
sorairolake wants to merge 2 commits intoziglang:masterfrom
Open
docs: Add doc comments to std.math.isNan#25822sorairolake wants to merge 2 commits intoziglang:masterfrom
std.math.isNan#25822sorairolake wants to merge 2 commits intoziglang:masterfrom
Conversation
Contributor
|
what is this adding over the name of the function? |
Contributor
Author
|
This function returns whether the given value is a NaN. This pull request adds documentation explaining this behavior. We can guess what this function does from the function name and examples, but I think it would be easier to understand if there is documentation. |
Contributor
Something along the lines of would be better because NaN is not being used to describe the |
Contributor
Author
|
@saurabh-mish suggestion: /// Returns `true` if `x` is not a number (NaN), and `false` otherwise.or /// Returns `true` if `x` is NaN (not a number), and `false` otherwise. |
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
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.
std.math.isNanhas no doc comments, so add it.