wpilibsuite/wpilib-docs

Clean up Command factory/constructor documentation

開放

#2,293 建立於 2023年7月17日

在 GitHub 查看
 (0 則留言) (0 個反應) (0 位負責人)JavaScript (297 個分叉)auto 404
Good First Issue

倉庫指標

星標
 (187 顆星)
PR 合併指標
 (平均合併 7天 6小時) (30 天內合併 14 個 PR)

描述

https://docs.wpilib.org/en/2023_a/docs/software/commandbased/commands.html

Currently there is an inconsistent/incomplete mix of using the constructor and using the factory method inside the code blocks, while the documentation refers to the factory methods.

The code blocks/RLIs also use the factory methods of Subsystem in the context of a subsystem (eg using this.runOnce) which can be confusing without the surrounding context.

貢獻者指南

研究方向
查看連結的文檔頁面，識別不一致使用建構函式與工廠方法的程式碼區塊，並與提及工廠方法的周圍文字進行比較。更新程式碼區塊以匹配文檔中描述的工廠方法用法。同時，檢查在子系統上下文中使用 `this.runOnce` 的情況，確保清晰性。
技術棧
javacpp
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Git
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70