[Docs][Concurrency] Document custom executors in API docs a bit #73634
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ktoso
added
concurrency
|
Would welcome some review if that's the tense and format we're okey with -- if so, I'll follow up with more documentation on APIs. |
|
@swift-ci please smoke test |
1 similar comment
|
@swift-ci please smoke test |
|
Second commit now resolves rdar://129115666 and did some review followup about wording as well that Michael suggested -- we're now more emphasizing the every actor has its own executor and showing the "shared" case only at the very end and warning about it. |
Include review feedback and show how to customize a single actor by passing an executor through initializer
ktoso
force-pushed
the
wip-document-exexecutors-apidoc
branch
from
757c5be to
89adc82
Compare
|
@swift-ci please smoke test |
ktoso
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on https://forums.swift.org/t/how-to-properly-use-custom-executor-on-global-actor/71829/ I realized we don't do a good job documenting custom executors (and other things, but let's start with this) on API docs.
This introduces some basic example and wording in the Actor and SerialExecutor types.
More should be preferably done in the TSPL, but we'll handle that separately.
Resolves rdar://128060412 rdar://129115666