-
Notifications
You must be signed in to change notification settings - Fork 5
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
DutyCycleEncoder rewrite is not documented as "Breaking" #62
Comments
The behavior changed enough where we'd probably rather have the break so users actually look at where they used that code. Rollover support was completely removed, as it was broken in hardware. Doing this let us add better mapping support, so getting the absolute value as expected should be easier. |
Should we update the docs page to describe it as breaking, though? (And maybe move it closer to the top? I'm not familiar with the typical structure of the "New for ..." pages to know if there's already a particular order they're in) |
OK, that seems reasonable. I think then there needs to be a description of what to look at in user code that might be broken. The documentation for |
Describe the bug
DutyCycleEncoder.getAbsolutePosition
changed toDutyCycleEncoder.get
buthttps://docs.wpilib.org/en/latest/docs/yearly-overview/yearly-changelog.html#new-for-2025
just saysDutyCycleEncoder
was rewritten.DutyCycleEncoderSim
is also affected for both theget
andset
methods.There may be a similar issue with AbsoluteEncoder (mentioned as rewritten on the same line of the change log).
Expected behavior
At a minimum, the change log should flag the breaking change. Maybe the project importer could make the change automatically? Is that safe? I.e., is the change as simple as changing the method name or are there other semantic considerations that need to be accounted for? If so, some guidance is needed.
The text was updated successfully, but these errors were encountered: