microsoft / microsoft/vs-threading
Threading doc improvements
Open
Nobody has claimed this yet.
documentation
- Dominant language
- C#
- Stars
- 1k
- Forks
- 160
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 28
Description
@vukelich has two suggestions:
- Quick dictionary for some of the major terms. "Join"/"Joinable" was something I think seemed to cause confusion, for example.
- A diagram that shows the relationship between the JTF, a joinable collection, a joinable task, regular Tasks and TaskCompletionSources, and how these prevent or cause a hang by violating rule #3.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing threading documentation and the section describing rule #3, then review how it defines JTF, joinable collections, joinable tasks, regular Tasks, and TaskCompletionSources. Done means adding a quick dictionary for major terms such as Join and Joinable, plus a diagram showing those relationships and how violating rule #3 can cause a hang.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100