Skip to content

Commit c7d98c7

Browse files
Add SubprocessError symbol links to error-throwing docs (swiftlang#323)
1 parent e78e27c commit c7d98c7

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

Sources/Subprocess/IO/Input.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ public final actor StandardInputWriter: Sendable {
283283

284284
/// Writes an array of bytes to the subprocess's standard input.
285285
/// - Parameter array: The bytes to write.
286-
/// - Throws: `SubprocessError` with error code `.failedToWriteToSubprocess`.
286+
/// - Throws: ``SubprocessError`` with error code ``SubprocessError/Code/failedToWriteToSubprocess``.
287287
/// See ``SubprocessError/underlyingError`` for more details. Also throws
288288
/// this error if the writer has already finished (see ``finish()``).
289289
/// - Returns: The number of bytes written.
@@ -299,7 +299,7 @@ public final actor StandardInputWriter: Sendable {
299299
/// Writes a raw span to the subprocess's standard input.
300300
///
301301
/// - Parameter span: The span to write.
302-
/// - Throws: `SubprocessError` with error code `.failedToWriteToSubprocess`.
302+
/// - Throws: ``SubprocessError`` with error code ``SubprocessError/Code/failedToWriteToSubprocess``.
303303
/// See ``SubprocessError/underlyingError`` for more details. Also throws
304304
/// this error if the writer has already finished (see ``finish()``).
305305
/// - Returns: The number of bytes written.
@@ -314,7 +314,7 @@ public final actor StandardInputWriter: Sendable {
314314
/// - Parameters:
315315
/// - string: The string to write.
316316
/// - encoding: The encoding to use when converting the string to bytes.
317-
/// - Throws: `SubprocessError` with error code `.failedToWriteToSubprocess`.
317+
/// - Throws: ``SubprocessError`` with error code ``SubprocessError/Code/failedToWriteToSubprocess``.
318318
/// See ``SubprocessError/underlyingError`` for more details. Also throws
319319
/// this error if the writer has already finished (see ``finish()``).
320320
/// - Returns: The number of bytes written.
@@ -337,7 +337,7 @@ public final actor StandardInputWriter: Sendable {
337337
/// After finishing, further writes throw a ``SubprocessError`` with the code
338338
/// ``SubprocessError/Code/failedToWriteToSubprocess``.
339339
///
340-
/// - Throws: `SubprocessError` with error code `.asyncIOFailed`.
340+
/// - Throws: ``SubprocessError`` with error code ``SubprocessError/Code/asyncIOFailed``.
341341
/// See ``SubprocessError/underlyingError`` for more details.
342342
public func finish() async throws(SubprocessError) {
343343
guard !self.didFinish else {

Sources/Subprocess/Platforms/Subprocess+Unix.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ extension Execution {
9999
/// - signal: The signal to send.
100100
/// - shouldSendToProcessGroup: Whether this signal should be sent to
101101
/// the entire process group.
102-
/// - Throws: `SubprocessError` with error code `.processControlFailed`.
103-
/// See `.underlyingError` for more details.
102+
/// - Throws: ``SubprocessError`` with error code ``SubprocessError/Code/processControlFailed``.
103+
/// See ``SubprocessError/underlyingError`` for more details.
104104
public func send(
105105
signal: Signal,
106106
toProcessGroup shouldSendToProcessGroup: Bool = false

0 commit comments

Comments
 (0)