Skip to content

Add documentation for numeric value comparison within specified accuracy #165 #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 24, 2024
Merged

Add documentation for numeric value comparison within specified accuracy #165 #314

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c37bce0
Add documentation for numeric value comparison #165
wangxingyu5529 Mar 24, 2024
6146f30
Add a blank line
wangxingyu5529 Mar 24, 2024
4998349
Move comment to the migration document
wangxingyu5529 Mar 26, 2024
02515ac
Address comments on phrasing
wangxingyu5529 Apr 6, 2024
44ae5fd
Address more comments
wangxingyu5529 Apr 7, 2024
3dc931f
Paraphrase by stating the problem first
wangxingyu5529 Apr 13, 2024
716cdff
Use single backticks around isApproximatelyEqual
wangxingyu5529 Apr 21, 2024
849d0fa
Merge branch 'main' into main
wangxingyu5529 Apr 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Sources/Testing/Testing.docc/MigratingFromXCTest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,11 @@ their equivalents in the testing library:
| `try XCTUnwrap(x)` | `try #require(x)` |
| `XCTFail("…")` | `Issue.record("…")` |

The testing library doesn’t provide an equivalent of
[`XCTAssertEqual(_:_:accuracy:_:file:line:)`](https://developer.apple.com/documentation/xctest/3551607-xctassertequal).
To compare two numeric values within a specified accuracy,
use `isApproximatelyEqual()` from [swift-numerics](https://github.com/apple/swift-numerics).

### Continue or halt after test failures

An instance of an `XCTestCase` subclass can set its
Expand Down