TimelyDataflow / TimelyDataflow/timely-dataflow
Outdated text in "Creating Operators" subsection of book
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 3.6k
- Forks
- 293
- Avg merge
- 14h 46m
- Merged PRs (30d)
- 4
Description
In this section of the book, I got lost for a bit and I believe it's due to the fact the example was updated but not synced with the explanatory text. In particular, this relatively recent commit updated the actual example, but the corresponding explanation has not been updated since this commit from 6 years ago.
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 with the linked “Creating Operators” subsection in chapter 2.4 of the book, then compare the updated example from commit 729f75bd0adbb652c80717117957fbfcb40f733c with the explanatory text last changed in commit 6d1cca4c41b10bbcc727572990f68c40d95fa7a5. Done means the explanation accurately describes the current example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100