Skip to content

Stop listing two protocols that were removed in 2021 - #11957

Open
MrScothh wants to merge 1 commit into
iNavFlight:maintenance-10.xfrom
MrScothh:fix/stale-motor-protocol-description
Open

MrScothh wants to merge 1 commit into
iNavFlight:maintenance-10.xfrom
MrScothh:fix/stale-motor-protocol-description

Conversation

@MrScothh

Copy link
Copy Markdown

motor_pwm_protocol's description still lists ONESHOT42 and DSHOT1200. Both were removed in July 2021 - 4713d58 "Drop OneShot42" and d42e5ad "Drop DSHOT1200" - and the values the setting accepts have been STANDARD, ONESHOT125, MULTISHOT, BRUSHED, DSHOT150, DSHOT300, DSHOT600 ever since.

The description is what generates docs/Settings.md, so the reference documentation has spent four years offering two protocols that no firmware built since then will accept. Setting either gives Invalid value with the real list, so nothing is broken - it just sends people looking for something that is not there.

Documentation only; no functional change.

🤖 Generated with Claude Code

The description of motor_pwm_protocol still offers ONESHOT42 and DSHOT1200.
Both were dropped in July 2021 - 4713d58 and d42e5ad - and the values the
setting actually accepts have been STANDARD, ONESHOT125, MULTISHOT, BRUSHED,
DSHOT150, DSHOT300 and DSHOT600 ever since.

It reads straight into docs/Settings.md, so the reference documentation has been
advertising two protocols that no firmware since then will accept.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@qodo-code-review

Copy link
Copy Markdown
Contributor

ⓘ Qodo reviews are paused because the subscription is no longer active. Ask your workspace admin to reactivate the subscription to resume reviews. Manage billing

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can group findings by type and pick your Finding display, from Minimal to Full

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Remove obsolete motor protocols from settings documentation

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Removes obsolete ONESHOT42 and DSHOT1200 options from motor protocol documentation.
• Synchronizes the generated settings reference with firmware-accepted protocol values.
Diagram

graph TD
  A["settings.yaml"] -->|read by| B["Docs generator"] -->|writes| C["Settings.md"]
Loading
High-Level Assessment

The current approach is optimal: correcting both the canonical metadata and committed generated reference keeps them aligned. Runtime tables and validation require no changes because the accepted values were already correct.

Files changed (2) +2 / -2

Documentation (2) +2 / -2
Settings.mdRemove unsupported protocols from generated settings reference +1/-1

Remove unsupported protocols from generated settings reference

• Removes ONESHOT42 and DSHOT1200 from the documented motor_pwm_protocol options so the reference matches firmware-supported values.

docs/Settings.md

settings.yamlCorrect motor protocol setting description +1/-1

Correct motor protocol setting description

• Updates the canonical motor_pwm_protocol description to list only currently accepted protocols, ensuring future generated documentation remains accurate.

src/main/fc/settings.yaml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant