TimelyDataflow / TimelyDataflow/differential-dataflow

maybe the doc should add some instructions at geting started section

Open
#406 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
3k
Forks
211
Avg merge
10h 42m
Merged PRs (30d)
34

Description

the doc surely has these content, but as a newbie it will still be confused.
i think should add instructions on getting started section as follows:

  1. input.advance_to: it make dd wont accept input changes older than the time.
  2. input.flush: advance_to is just a buffer, flush labeled this will happen.
  3. worker.step: the above is just configs, and only work.step will make this happen.
  4. when exit dd, dd will call worker.step once, make all the work happens. but when you write your loop or infinite graphs, you should call worker.step whenever you need your computation works
  5. in a nut shell, in your program, you should call 1-3 sequencetially, otherwise you maybe see hungs.

i think these will make things easier

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Getting Started section in the repository documentation and read the surrounding explanation of input.advance_to, input.flush, and worker.step. Clarify the sequence and shutdown behavior described in the issue, then update that section with the numbered guidance and verify that the instructions match the existing examples.

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
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.