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 合并指标
 (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