chore(assert): complete documentation #3900
Merged
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
kt3k
reviewed
Dec 6, 2023
Comment on lines
-17
to
-18
| * assertAlmostEquals(0.1 + 0.2, 0.3, 1e-16); | ||
| * assertThrows(() => assertAlmostEquals(0.1 + 0.2, 0.3, 1e-17)); |
There was a problem hiding this comment.
I think these are good examples for illustrating what tolerance is for. Let's keep them too
kt3k
reviewed
Dec 6, 2023
assert/assert_almost_equals.ts
Outdated
| * Make an assertion that `actual` and `expected` are almost equal numbers | ||
| * through a given tolerance. It can be used to take into account IEEE-754 | ||
| * double-precision floating-point representation limitations. If the values | ||
| * are not almost equal then throw. | ||
| * | ||
| * @example | ||
| * ```ts | ||
| * import { assertAlmostEquals, assertThrows } from "https://deno.land/std@$STD_VERSION/assert/mod.ts"; |
There was a problem hiding this comment.
assertThrows looks now unnecessary?
kt3k
reviewed
Dec 6, 2023
kt3k
reviewed
Dec 6, 2023
|
Mostly looks good. Left a few comments |
Co-authored-by: Yoshiya Hinosawa <stibium121@gmail.com>
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.
Towards #3764 and #3878.