Skip to content

Commit 8471b1f

Browse files
authored
Fix some typos in documentation. (#1156)
This PR fixes some typos/minor errors in our documentation. Resolves #1118. ### Checklist: - [x] Code and documentation should follow the style of the [Style Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md). - [x] If public symbols are renamed or modified, DocC references should be updated.
1 parent 567285e commit 8471b1f

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

Sources/Testing/ExitTests/ExitTest.Result.swift

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ extension ExitTest {
4343
///
4444
/// When checking the value of this property, keep in mind that the standard
4545
/// output stream is globally accessible, and any code running in an exit
46-
/// test may write to it including including the operating system and any
47-
/// third-party dependencies you have declared in your package. Rather than
48-
/// comparing the value of this property with [`==`](https://developer.apple.com/documentation/swift/array/==(_:_:)),
46+
/// test may write to it including the operating system and any third-party
47+
/// dependencies you have declared in your package. Rather than comparing
48+
/// the value of this property with [`==`](https://developer.apple.com/documentation/swift/array/==(_:_:)),
4949
/// use [`contains(_:)`](https://developer.apple.com/documentation/swift/collection/contains(_:))
5050
/// to check if expected output is present.
5151
///
@@ -73,10 +73,10 @@ extension ExitTest {
7373
/// instead.
7474
///
7575
/// When checking the value of this property, keep in mind that the standard
76-
/// error stream is globally accessible, and any code running in an exit
77-
/// test may write to it including including the operating system and any
78-
/// third-party dependencies you have declared in your package. Rather than
79-
/// comparing the value of this property with [`==`](https://developer.apple.com/documentation/swift/array/==(_:_:)),
76+
/// output stream is globally accessible, and any code running in an exit
77+
/// test may write to it including the operating system and any third-party
78+
/// dependencies you have declared in your package. Rather than comparing
79+
/// the value of this property with [`==`](https://developer.apple.com/documentation/swift/array/==(_:_:)),
8080
/// use [`contains(_:)`](https://developer.apple.com/documentation/swift/collection/contains(_:))
8181
/// to check if expected output is present.
8282
///

Sources/Testing/Testing.docc/exit-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,4 +153,4 @@ extension Customer {
153153

154154
The testing library always sets ``ExitTest/Result/exitStatus`` to the actual
155155
exit status of the child process (as reported by the system) even if you do not
156-
pass it.
156+
observe `\.exitStatus`.

Sources/_TestDiscovery/TestContentRecord.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ public struct TestContentRecord<T> where T: DiscoverableAsTestContent {
7171
///
7272
/// | Platform | Pointer Type |
7373
/// |-|-|
74-
/// | macOS, iOS, watchOS, tvOS, visionOS | `UnsafePointer<mach_header64>` |
75-
/// | Linux, FreeBSD, Android | `UnsafePointer<ElfW_Ehdr>` |
74+
/// | macOS, iOS, watchOS, tvOS, visionOS | `UnsafePointer<mach_header_64>` |
75+
/// | Linux, FreeBSD, Android | `UnsafePointer<ElfW(Ehdr)>` |
7676
/// | OpenBSD | `UnsafePointer<Elf_Ehdr>` |
7777
/// | Windows | `HMODULE` |
7878
///

0 commit comments

Comments
 (0)