Skip to content

Conversation

@stmontgomery
Copy link
Contributor

@stmontgomery stmontgomery commented May 3, 2025

This reverts a portion of the changes I made in #836 which converted triple-/// style DocC @Comment blocks to double-// style code comments. That change was needed at the time because our documentation was still rendered using pre-Swift 6.1 toolchains, but now @Comment blocks are supported by DocC in documentation comments (as of swiftlang/swift-docc#1107) so we can restore these.

I needed to move some of these comment blocks up before ## See Also sections to avoid a DocC warning about items in lists not being links.

Checklist:

  • Code and documentation should follow the style of the Style Guide.
  • If public symbols are renamed or modified, DocC references should be updated.

@stmontgomery stmontgomery added documentation 📚 Improvements or additions to documentation enhancement New feature or request labels May 3, 2025
@stmontgomery stmontgomery added this to the Swift 6.x milestone May 3, 2025
@stmontgomery stmontgomery self-assigned this May 3, 2025
@stmontgomery
Copy link
Contributor Author

@swift-ci please test

@stmontgomery stmontgomery added the self-reviewed PR was self-reviewed by a code owner label May 3, 2025
@stmontgomery stmontgomery merged commit 6e4fe1f into swiftlang:main May 3, 2025
3 checks passed
@stmontgomery stmontgomery deleted the docc-comments branch May 3, 2025 13:07
@stmontgomery stmontgomery modified the milestones: Swift 6.x, Swift 6.2 May 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📚 Improvements or additions to documentation enhancement New feature or request self-reviewed PR was self-reviewed by a code owner

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant