Explain the role of Deterministics in the docs
Open
Nobody has claimed this yet.
docs
enhancements
hackathon
- Dominant language
- Python
- Stars
- 9.8k
- Forks
- 2.3k
- Avg merge
- 21h 39m
- Merged PRs (30d)
- 5
Description
Description
While #6695 is a bit dramatic and I have changed my mid about it a couple of times, we should at least mention on the docstrings of Deterministic that they are optional.
We could show explicitly the same code with and without them.
Also emphasize when they're needed:
- You want to easily access values in the trace
- You want to target for model transforms like do/observe
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 Deterministic docstrings and the current documentation examples. Compare usage with and without Deterministic, then document that it is optional and explain the listed cases: accessing values in the trace and targeting model transforms such as do/observe. Done means these examples and use cases are clear in the docs.
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
- 35/100