Document thread safety
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 24.3k
- Forks
- 1.3k
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 16
Description
Currently, simdjson is very much thread safe. I think that this should appear in the doxygen documentation, and any concurrency issue should be documented (there are none that I know of).
There is talk by @jkeiser of introducing a state in the object and array element. If so, we should discuss thread safety in the documentation as clearly as possible.
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 Doxygen documentation and reviewing how thread safety and concurrency are currently described. Done means the documentation clearly states the thread-safety guarantee and records any known concurrency limitations, including implications of possible state in object and array elements.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100