Skip to content

Commit 1d1bef3

Browse files
committed
Fix abstracts to follow reference style.
- Use a present tense verb phrase - Avoid repeating the symbol's name
1 parent a74751c commit 1d1bef3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Sources/System/FileOperations.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ extension FileDescriptor {
158158
nothingOrErrno(retryOnInterrupt: false) { system_close(self.rawValue) }
159159
}
160160

161-
/// Reposition the offset for the given file descriptor.
161+
/// Repositions the offset for the given file descriptor.
162162
///
163163
/// - Parameters:
164164
/// - offset: The new offset for the file descriptor.
@@ -371,7 +371,7 @@ extension FileDescriptor {
371371

372372
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
373373
extension FileDescriptor {
374-
/// Duplicate this file descriptor and return the newly created copy.
374+
/// Duplicates this file descriptor and return the newly created copy.
375375
///
376376
/// - Parameters:
377377
/// - `target`: The desired target file descriptor, or `nil`, in which case
@@ -437,7 +437,7 @@ extension FileDescriptor {
437437
#if !os(Windows)
438438
@available(/*System 1.1.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
439439
extension FileDescriptor {
440-
/// Create a pipe, a unidirectional data channel which can be used for interprocess communication.
440+
/// Creates a unidirectional data channel, which can be used for interprocess communication.
441441
///
442442
/// - Returns: The pair of file descriptors.
443443
///
@@ -466,7 +466,7 @@ extension FileDescriptor {
466466
#if !os(Windows)
467467
@available(/*System 1.2.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
468468
extension FileDescriptor {
469-
/// Truncate or extend the file referenced by this file descriptor.
469+
/// Truncates or extends the file referenced by this file descriptor.
470470
///
471471
/// - Parameters:
472472
/// - newSize: The length in bytes to resize the file to.

0 commit comments

Comments
 (0)