Skip to content

Add discussion of main actor and @globalActor [SE-0316] #366

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
Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

Add discussion of main actor and @globalActor [SE-0316] #366

wants to merge 19 commits into from

Conversation

amartini51
Copy link
Member

In the past, TSPL largely depended on the API reference for the MainActor type to document its use as an attribute. However, the role of the main actor is more important in the Swift 6.2 flavor of concurrency, so we need to discuss it in the book as part of the conceptual framing.

Fixes: rdar://80904458

amartini51 added 16 commits May 7, 2024 16:22
@amartini51
Start outlining
a2096cf
@amartini51
Discuss data races in the intro
1eaa2fa
@amartini51
Convert outline for Main Actor from RST to markdown
e812873
@amartini51
Call out two tripping hazards
f75bd8f 
These changes were stashed after commit 9e46469 (Incorporate tech
review from Evan, 2023-10-16) and might have been originally intended to
be part of that commit.

References: 9e46469
@amartini51
Track 'main' to resolve merge conflicts
0f3acee
@amartini51
Expand compile/run time race detection
34fdd99
@amartini51
Update some comments & outlines
6c09713
@amartini51
Outline @globalActor reference; shift Main Actor section
b46a62b
@amartini51
Expand outline for main actor
e81ac4c
@amartini51
Show @mainactor on functions and types
61838a1
@amartini51
Expand examples & discussion of the main actor
70e3662
@amartini51
Remove data-race triangle section
72c83e6 
I'm moving this to its own branch, to write and review separately from
the @mainactor updates.
@amartini51
Work around some DocC issues
f3e96e4
@amartini51
Delete refactoring leftover
de7c7a5
@amartini51
Finish the explanation of a code listing
4faabaa
@amartini51
Fill in placeholder reference
fda2149
@stzn stzn mentioned this pull request May 6, 2025
Open
amartini51 added 2 commits May 6, 2025 15:04
@amartini51
Remove RST-style heading underlines
23bcdef 
This works around a known issue in DocC:

    swiftlang/swift-markdown#88

With the tilde underlines, @mainactor in code was being treated as a
DocC at-directive, leading to incorrect output
@amartini51
Back out the previous DocC workaround
e772cfe 
This reverts most of commit f3e96e4.
Removing the tildes is much better than nonbreaking spaces in code.
colleenish
colleenish suggested changes May 10, 2025
View reviewed changes
Copy link

@colleenish colleenish left a comment

Choose a reason for hiding this comment

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

First pass edits.

@amartini51 amartini51 marked this pull request as ready for review May 12, 2025 20:25
@amartini51
Incorporate editorial corrections
2dbf991 
Edits from <rdar://150711369>

Co-authored-by: Colleen Toporek <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@colleenish colleenish colleenish requested changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@amartini51 @colleenish