Conversation
`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
Contributor
|
This change is fine, but we don't need kilobytes of LLM-generated explanations. This is a typo fix! |
Contributor
|
Thanks for trimming the summary. When you retarget the branch, you also have to cherry-pick the change to the new branch, sorry. As it is, it brings along a bunch of changes we want for 1.9.x, not for 1.8.x. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
targetparameter name was in backticks inside its- Parametercallout, so DocC treated it as inline code rather than a parameter name and the documentation never bound to the parameter.One character either side. Retargeted to
release/1.8.xas requested.