Skip to content

Fix the parameter callout on the mutating trimPrefix(while:) - #287

Open
hxperl wants to merge 1 commit into
apple:mainfrom
hxperl:trimprefix-parameter-callout
Open

hxperl wants to merge 1 commit into
apple:mainfrom
hxperl:trimprefix-parameter-callout

Conversation

@hxperl

@hxperl hxperl commented Sep 11, 2026 •

Copy link
Copy Markdown

Trim.swift:83, on the Self == Self.SubSequence overload of trimPrefix(while:):

/// - Parameters predicate: A closure that determines if the element should

DocC reads - Parameters as the header of a nested list rather than a - Parameter <name>: entry. Nothing follows it indented, so the entry binds to nothing and the description never renders.

Singular - Parameter.

The `Collection where Self == Self.SubSequence` overload of
`trimPrefix(while:)` writes its parameter callout as
`- Parameters predicate:` — plural `Parameters`, which DocC reads as the
header of a nested parameter list rather than as a `- Parameter <name>:`
entry. Because no nested list follows, the entry binds to nothing and the
description is dropped from the rendered page entirely: the method shows no
Parameters section at all.

The other eight callouts in this file, including the near-identical
overload 25 lines above, already use the singular form.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants