docs: Add hints in the docs on how to manage tracing with multi-threading
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 421
- Forks
- 60
- Avg merge
- 9h 30m
- Merged PRs (30d)
- 4
Description
Tracing relies on context variables, that if they are not correctly copied in the new context when asynchronous, or multi-threaded code is executed, make the whole tracing mechanism to fail. We should make this clearer in the docs, adding also some suggestions on how to make tracing work properly when running async and multi-threaded code.
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 tracing documentation and the context-variable handling relevant to asynchronous and multi-threaded execution. Document why context must be copied into new contexts, add practical suggestions for keeping tracing working, and verify that the guidance covers both async and multi-threaded code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100