Improve documentation of volatile keyword
#24318
Assignees
Comments
Merged
|
Hi @BillWagner - should this have been closed from #24315? |
|
While reviewing that PR I found a few more things that should be fixed so this issue is tracking that |
|
Thanks @kouvel for picking this up! I'm glad to see even more eyes on this. :) |
kouvel
added a commit
to kouvel/dotnet-api-docs
that referenced
this issue
Sep 10, 2021
- Clarify terms used in `LazyThreadSafetyMode` field names. Relevant to dotnet/docs#12214. - Clarify documentation of the `Volatile` class. Relevant to dotnet/docs#24318. - Update docs for `Thread.VolatileRead` and `Thread.VolatileWrite`. Fixes dotnet#2518. - Clarify something about `ManualResetEventSlim`'s perf benefit over `ManualResetEvent`. Fixes dotnet#3323.
kouvel
added a commit
to kouvel/docs
that referenced
this issue
Sep 10, 2021
- Document new settings available to configure the rate of thread injection for sync-over-async. Fixes dotnet#24566. - Clarify documentation of the `volatile` keyword. Fixes dotnet#24318. - Add link to clarify some terms in `LazyThreadSafetyMode` field names. Fixes dotnet#12214.
This was referenced Sep 10, 2021
carlossanlop
pushed a commit
to dotnet/dotnet-api-docs
that referenced
this issue
Sep 13, 2021
* Clarify/fix some threading API docs - Clarify terms used in `LazyThreadSafetyMode` field names. Relevant to dotnet/docs#12214. - Clarify documentation of the `Volatile` class. Relevant to dotnet/docs#24318. - Update docs for `Thread.VolatileRead` and `Thread.VolatileWrite`. Fixes #2518. - Clarify something about `ManualResetEventSlim`'s perf benefit over `ManualResetEvent`. Fixes #3323. * Apply suggestions from code review Thank you! Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
kouvel
added a commit
that referenced
this issue
Sep 13, 2021
* Clarify/fix some threading docs - Document new settings available to configure the rate of thread injection for sync-over-async. Fixes #24566. - Clarify documentation of the `volatile` keyword. Fixes #24318. - Add link to clarify some terms in `LazyThreadSafetyMode` field names. Fixes #12214. Co-authored-by: Genevieve Warren <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Improve documentation of
volatilekeyword indocs/csharp/language-reference/keywords/volatile.mdto clarify what it does and fix some inaccurate info.-edit by @BillWagner to add document block.
Document Details
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
The text was updated successfully, but these errors were encountered: