Clarify/fix some threading API docs #7137
Conversation
- 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.
|
Docs Build status updates of commit 16dc07c: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
| @@ -982,7 +985,7 @@ | |||
| </Parameters> | |||
| <Docs> | |||
| <param name="location">The field where the value is written.</param> | |||
| <param name="value">The value to write. The value is written immediately so that it is visible to all processors in the computer.</param> | |||
There was a problem hiding this comment.
is the extra clarification not required, or has the behavior now changed?
There was a problem hiding this comment.
The behavior hasn't changed, just removing the statement since it's incorrect
Thank you! Co-authored-by: Genevieve Warren <[email protected]>
|
Docs Build status updates of commit 523633a: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
LazyThreadSafetyModefield names. Relevant to Why ExecutionAndPublication and PublicationOnly have such names? docs#12214.Volatileclass. Relevant to Improve documentation ofvolatilekeyword docs#24318.Thread.VolatileReadandThread.VolatileWrite. Fixes Thread.VolatileRead/Write remarks and volatile keyword #2518.ManualResetEventSlim's perf benefit overManualResetEvent. Fixes Define "very short" in Remark for ManualResetEventSlim #3323.