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.
Improve List documentation · linebender/druid#803 | Good First Issue