wpilibsuite/wpilib-docs

Clean up Command factory/constructor documentation

Open

#2,293 opened on Jul 17, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (297 forks)auto 404
Good First Issue

Repository metrics

Stars
 (187 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Review the linked documentation page, identify code blocks that inconsistently use constructor vs factory methods, and compare with the surrounding text that refers to factory methods. Update code blocks to match the factory method usage described in the documentation. Also, check for usage of `this.runOnce` in subsystem context and ensure clarity.
Tech stack
javacpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70