linebender/druid

Improve List documentation

Open

#803 opened on Apr 5, 2020

View on GitHub
 (2 comments) (4 reactions) (0 assignees)Rust (9,091 stars) (567 forks)batch import
D-Easydocshelp wanted

Description

The List 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

Tech stack
rust
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Rust knowledgeFamiliarity with druid
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the existing List widget source code and its example project. Add documentation to the struct's doc comments covering the purpose of List, usage of ListIter, and scrolling. Ensure the documentation is clear and helpful for new users.