Skip to content

[Concurrency] Cleanup of assert/precondition/assume isolated docs #70800

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.

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

Merged
merged 2 commits into from
Jan 11, 2024

Conversation

ktoso
Copy link
Contributor

@ktoso ktoso commented Jan 10, 2024

Major revamp of documentation of all the assert / precondition / assume isolated docs.

The docs now explain more about the exact semantics, avoid mentioning behavior that was not actually implemented for the -Ounchecked mode, and explain semantics in face of sharing the same serial executor.

This should also help understanding in face of task executors -- as we explicitly say that these use the serial executor of actors and not the task executor.

resolves rdar://115729096

@ktoso ktoso requested a review from kavon as a code owner January 10, 2024 02:51
@ktoso ktoso changed the title [Concurrency] Major cleanup of assert/percondition/assume isolated docs [Concurrency] Major cleanup of assert/precondition/assume isolated docs Jan 10, 2024
@ktoso ktoso requested a review from amartini51 January 10, 2024 02:51
@ktoso ktoso added concurrency Feature: umbrella label for concurrency language features documentation labels Jan 10, 2024
@ktoso ktoso force-pushed the wip-assert-isolated-docs-revamp branch from 005070b to 742e483 Compare January 10, 2024 03:04
@ktoso
Copy link
Contributor Author

ktoso commented Jan 10, 2024

@swift-ci please smoke test

@ktoso
Copy link
Contributor Author

ktoso commented Jan 10, 2024

Linux CI has unrelated issues right now, need to wait it out

Copy link
Member

@amartini51 amartini51 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this, Konrad! Made some changes to fix odd punctuation and revise wording. Marked each change only the first time, since similar docs are repeated on similar APIs.

I can take another pass tomorrow if you want, to help you follow the style guidance for API reference a little more closely.

Co-authored-by: Alex Martini <amartini@apple.com>
@ktoso
Copy link
Contributor Author

ktoso commented Jan 11, 2024

Thank you for the review @amartini51 !

@ktoso
Copy link
Contributor Author

ktoso commented Jan 11, 2024

@swift-ci please smoke test

@ktoso ktoso enabled auto-merge (squash) January 11, 2024 04:45
@ktoso ktoso requested a review from amartini51 January 11, 2024 04:46
@ktoso ktoso changed the title [Concurrency] Major cleanup of assert/precondition/assume isolated docs [Concurrency] Cleanup of assert/precondition/assume isolated docs Jan 11, 2024
@ktoso ktoso merged commit 70b1c0e into swiftlang:main Jan 11, 2024
@ktoso ktoso deleted the wip-assert-isolated-docs-revamp branch January 11, 2024 08:16
Catfish-Man pushed a commit to Catfish-Man/swift that referenced this pull request Jan 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
concurrency Feature: umbrella label for concurrency language features documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants