Skip to content

Documentation updates for latest DocC#596

Merged
lorentey merged 4 commits intoapple:mainfrom
lorentey:doc-fixes
Mar 9, 2026
Merged

Documentation updates for latest DocC#596
lorentey merged 4 commits intoapple:mainfrom
lorentey:doc-fixes

Conversation

@lorentey
Copy link
Copy Markdown
Member

@lorentey lorentey commented Mar 9, 2026

DocC keeps changing its link syntax. The latest iteration appears to have trouble dealing with Self-taking or Self-returning methods, so change our API to replace Self with a direct mention of the concrete type. ¯\_(ツ)_/¯

That said, the new compiler also found a large number of mismatching parameter names, and that's really helpful.

Checklist

  • I've read the Contribution Guidelines
  • My contributions are licensed under the Swift license.
  • I've followed the coding style of the rest of the project.
  • I've added tests covering all new code paths my change adds to the project (if appropriate).
  • I've added benchmarks covering new functionality (if appropriate).
  • I've verified that my change does not break any existing tests or introduce unexplained benchmark regressions.
  • I've updated the documentation if necessary.

lorentey added 4 commits March 9, 2026 12:04
DocC keeps changing its link syntax. The latest iteration appears to have trouble dealing with `Self`-taking or `Self`-returning methods, so change our API to replace `Self` with a direct mention of the concrete type. ¯\\\_(ツ)\_/¯

That said, the new compiler also found a large number of mismatching parameter names, and that was really helpful.
@lorentey lorentey added this to the 1.4.1 milestone Mar 9, 2026
@lorentey lorentey merged commit 7d69e78 into apple:main Mar 9, 2026
39 checks passed
@lorentey lorentey deleted the doc-fixes branch March 9, 2026 23:15
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.

1 participant