linebender / linebender/parley
Document Parley
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 736
- Forks
- 120
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 53
Description
https://github.com/linebender/parley/blob/1290e2ca9190a1b896b2fcbbcf6521c2966b6585/parley/src/lib.rs#L88
is very much ungood.
There are two phases to this:
1) Scoping it to each module. (And updating to be `expect`). This ensures that modules which are fully documented don't regress (see #571...)
2) Documenting the remaining missing items.
Contributor guide
No contributing guide indexed for this repository
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 at src/lib.rs line 88 and review how the documentation check is currently scoped. Apply the two stated phases: scope it to each module and update it to use expect, then document the remaining missing items. Compare the result with the fully documented modules referenced in #571; done means the missing documentation is covered without regressions.
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
- 50/100