Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gearing argument documentation is vague #7647

Open
calcmogul opened this issue Jan 6, 2025 · 1 comment
Open

Gearing argument documentation is vague #7647

calcmogul opened this issue Jan 6, 2025 · 1 comment
Labels
component: wpilibc WPILib C++ component: wpilibj WPILib Java component: wpimath Math library type: bug Something isn't working. type: docs Related to documentation and information.

Comments

@calcmogul
Copy link
Member

It's unclear how to turn a gear ratio like 6.75:1 into the floating point argument users are supposed to plug in.

It should clarify a gear ratio is input:output (input to output), and that gets converted to input/output. A number greater than 1 is a reduction.

Every instance of the word gearing as an argument should be updated in the same way.

@calcmogul calcmogul added component: wpilibj WPILib Java component: wpilibc WPILib C++ component: wpimath Math library type: bug Something isn't working. labels Jan 6, 2025
@auscompgeek auscompgeek added the type: docs Related to documentation and information. label Jan 7, 2025
@chauser
Copy link
Contributor

chauser commented Jan 8, 2025

See also: wpilibsuite/frc-docs#1206
Different communities apparently have different conventions about whether a gear ratio like 6.75:1 should be considered input:output or output:input depending on whether they think a gear ratio is a turns ratio or a torque ratio. In response to docs issue 1206, clarifying language was added to drivetrain-model.rst using the torque ratio convention (output/input). (My preference would have been to document it with the turns ratio convention, as preferred in this issue, but the language is clear about what convention is in use and that's what matters most.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: wpilibc WPILib C++ component: wpilibj WPILib Java component: wpimath Math library type: bug Something isn't working. type: docs Related to documentation and information.
Projects
None yet
Development

No branches or pull requests

3 participants