linebender/druid

Improve List documentation

Open

#803 创建于 2020年4月5日

在 GitHub 查看
 (2 评论) (4 反应) (0 负责人)Rust (9,091 star) (567 fork)batch import
D-Easydocshelp wanted

描述

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

贡献者指南

技术栈
rust
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic Rust knowledgeFamiliarity with druid
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
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.