Skip to content

Enable the Docs soundness check #1314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Sep 17, 2025
Merged

Enable the Docs soundness check #1314

merged 4 commits into from
Sep 17, 2025

Conversation

stmontgomery
Copy link
Contributor

@stmontgomery stmontgomery commented Sep 12, 2025 •
edited
Loading

Enable the (currently-disabled) Docs soundness check via GitHub Actions.

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 this to the Swift 6.x (main) milestone Sep 12, 2025
@stmontgomery stmontgomery self-assigned this Sep 12, 2025
@stmontgomery stmontgomery added documentation 📚 Improvements or additions to documentation enhancement New feature or request build 🧱 Affects the project's build configuration or process labels Sep 12, 2025
@stmontgomery stmontgomery linked an issue Sep 12, 2025 that may be closed by this pull request
[CI] Enable License, Docs, Unacceptable language, and Format checks #1309
Closed
@stmontgomery stmontgomery marked this pull request as ready for review September 16, 2025 21:40
grynspan
grynspan reviewed Sep 17, 2025
View reviewed changes
@stmontgomery stmontgomery merged commit ae900b1 into swiftlang:main Sep 17, 2025
35 of 36 checks passed
@stmontgomery stmontgomery deleted the docs-soundness-check branch September 17, 2025 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@grynspan grynspan grynspan approved these changes

@briancroom briancroom Awaiting requested review from briancroom briancroom is a code owner

@suzannaratcliff suzannaratcliff Awaiting requested review from suzannaratcliff suzannaratcliff is a code owner

@jerryjrchen jerryjrchen Awaiting requested review from jerryjrchen jerryjrchen is a code owner

Assignees

@stmontgomery stmontgomery

Labels
build 🧱 Affects the project's build configuration or process documentation 📚 Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
Swift 6.x (main)
Development

Successfully merging this pull request may close these issues.

[CI] Enable License, Docs, Unacceptable language, and Format checks
2 participants
@stmontgomery @grynspan