TimelyDataflow / TimelyDataflow/timely-dataflow

Improving documentation

Open
#48 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
3.6k
Forks
293
Avg merge
14h 46m
Merged PRs (30d)
4

Description

This is a long-term improvement issue, to identify and improve lacking documentation. Although timely has #deny[missing_docs], this doesn't mean that the documentation is uniformly good. Several structs and methods could have clearer explanations of their roles and functionality, and several modules could have better explanations of their organization and principles.

Document improvement PRs are great and loved, especially with an eye towards increased clarity (if not necessarily increased word count).

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 surveying the repository's Rust structs, methods, and modules for unclear or missing explanations, using the existing documentation and the deny[missing_docs] lint as context. Choose a focused area, then improve its descriptions and organization principles; done means the selected documentation is clearer without unnecessary expansion.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.