wpilibsuite/allwpilib

Feedforward and feedback gain setters should mention they should only be used for online tuning

Closed

#7,787 opened on Feb 14, 2025

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)C++ (714 forks)auto 404
component: wpimatheffort: 1good first issuetype: docs

Repository metrics

Stars
 (1,281 stars)
PR merge metrics
 (PR metrics pending)

Description

Feedforwards in particular are designed for systems with constant gains. Besides the online tuning use case, using gain scheduling for them is not an intended use, and means the user hasn't correctly modeled their system.

Contributor guide

Research direction
Examine the feedforward and feedback gain setters and add a comment indicating they are intended only for online tuning.
Tech stack
cpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
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.
65