Skip to content
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

Replace @async mentions in manual with Threads.@spawn #55315

Merged
merged 6 commits into from
Aug 5, 2024

Conversation

Satvik
Copy link
Contributor

@Satvik Satvik commented Jul 30, 2024

According to #50356, @async is no longer recommended and new code should use Threads.@spawn. However, the manual still mentions @async in several places. This PR updates the user-visible mentions of @async to Threads.@spawn. I made sure to make docs locally afterwards and check that the references were updated.

Note: I'm not experienced with open source, so please let me know how I could clean up this PR or do things better. I tried to follow the contributing guidelines as closely as possible but it's likely I missed something.

@nsajko nsajko added the docs This change adds or pertains to documentation label Jul 30, 2024
@vchuravy vchuravy self-requested a review July 31, 2024 00:54
@giordano
Copy link
Contributor

Tangentially related issue: @sync is just barely documented #49921, it'd be nice to address also that one, while this part of the documentation is being revised.

@Satvik
Copy link
Contributor Author

Satvik commented Jul 31, 2024

Tangentially related issue: @sync is just barely documented #49921, it'd be nice to address also that one, while this part of the documentation is being revised.

Would it make sense to merge the multi-threading and asynchronous programming pages at this point? Tasks seem to be the main way to do either at this point, and single-threaded asynchronous programming is now basically a special case of the parallel + concurrent model (if I understand correctly). Alternatively, it could make sense to refactor them into a "how to" page focused on Tasks, and a lower-level details page focused on Atomics, Threadpools, etc.

I could take a stab at it if there's interest.

@LilithHafner
Copy link
Member

Thank you for your contribution! This PR looks great.

@giordano, documenting @sync better would be another good improvement, but does not block merging this PR now.

@LilithHafner LilithHafner merged commit 4200203 into JuliaLang:master Aug 5, 2024
6 of 8 checks passed
lazarusA pushed a commit to lazarusA/julia that referenced this pull request Aug 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants