linebender/druid

Improve List documentation

Open

#803 opened on Apr 5, 2020

View on GitHubContributor guide
 (2 comments) (4 reactions) (0 assignees)Rust (567 forks)batch import
D-Easydocshelp wanted

Repository metrics

Stars
 (9,091 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Examine the existing `List` widget source code and examples to write clear documentation explaining its purpose, usage with `ListIter`, and how to enable scrolling.
Tech stack
rust
Domain
frontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80