Improve List documentation
Open
Nobody has claimed this yet.
D-Easy
docs
help wanted
- Dominant language
- Rust
- Stars
- 9.7k
- Forks
- 565
- PR merge metrics
- No merged PRs in 30d
Description
The [`List`](https://docs.rs/druid/0.5.0/druid/widget/struct.List.html) widget does not really have any documentation right now except for the example project.
It would be nice if the docs would at least explain
- Why it is needed
- How to use it (including what `ListIter` is)
- How to make it scroll
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 docs.rs List page and the example project to understand the widget's current usage and the role of ListIter. Update the List documentation to explain why it is needed, how to use it, and how to make it scroll; done means all three topics are covered clearly in the API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100