TimelyDataflow / TimelyDataflow/timely-dataflow
Documentation suggestion: use different types for worker IDs, timestamps, and data
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 3.6k
- Forks
- 293
- Avg merge
- 14h 46m
- Merged PRs (30d)
- 4
Description
In the current documentation, integers are used for everything: worker identifiers, timestamps, and data. This makes the example code snippets unnecessarily confusing, as one has a harder time figuring out which is which and separating the concepts.
I think the examples would be much easier to understand if they used separate data types for all of these. As IIUC worker identifiers are necessarily integers, this leaves you free to use two other data types for inputs and timestamps. I guess arrays/tuples of integers or floats would make fine inputs, but I am not sure how flexible timely is with respect to timestamps. Is everything that has an ordering fine?
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 documentation examples that use integers for worker identifiers, timestamps, and data. Check what timestamp types timely accepts and update the examples to use distinct types, while preserving integer worker identifiers. Done means the examples clearly separate these concepts and the documentation explains any timestamp constraints.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100