wpilibsuite/wpilib-docs

Document DeferredCommand in Command Compositions article

Open

#2,368 opened on Oct 27, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (297 forks)auto 404
Component: WPILibJ/WPILibCGood First Issue

Repository metrics

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

Description

We should add a short example and explain why it should generally be preferred over the deferred proxy constructor (DeferredCommand keeps everything within the composition instead of delegating to the scheduler) https://docs.wpilib.org/en/latest/docs/software/commandbased/command-compositions.html

Contributor guide

Research direction
Add a short example and explanation for DeferredCommand, explaining why it should be generally preferred over the deferred proxy constructor. The example should illustrate how DeferredCommand keeps everything within the composition instead of delegating to the scheduler.
Tech stack
None
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.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
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.
80