mirror of
https://github.com/apple/swift-system
synced 2026-11-22 04:30:46 +00:00
Unbacktick the target parameter name so DocC recognises it
`FileDescriptor.duplicate(as:retryOnInterrupt:)` writes its first parameter entry as ``- `target`:`` rather than `- target:`. DocC matches parameter documentation by the bare identifier, so the backticked entry is not associated with the parameter: the description is dropped from the rendered parameter list and DocC reports the parameter as undocumented. The `duplicate(as:options:retryOnInterrupt:)` overload twenty lines below documents the same parameter without backticks, which is what this changes the first overload to match. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MDv2d3fEYCVWGpu7AgD4qq
This commit is contained in:
1 parent
53b1815f41
commit
e96ba28879
1 file changed
+1
-1
@@ -381,7 +381,7 @@ extension FileDescriptor {
|
||||
/// Duplicates this file descriptor and returns the newly created copy.
|
||||
///
|
||||
/// - Parameters:
|
||||
/// - `target`: The desired target file descriptor, or `nil`, in which case
|
||||
/// - target: The desired target file descriptor, or `nil`, in which case
|
||||
/// the copy is assigned to the file descriptor with the lowest raw value
|
||||
/// that is not currently in use by the process.
|
||||
/// - retryOnInterrupt: Whether to retry the duplicate operation
|
||||
|
||||
Reference in new issue
Block a user