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

Add checkstyle check for deprecation #7738

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sciencewhiz
Copy link
Contributor

Ensures java deprecated notation is paired with javadoc and vice versa.
Adds javadoc deprecation for MecanumControllerCommand, ArmFeedForward, ElevatorFeedforward, and MecanumDriveMotorVoltages
Fixes #7736
Supersedes #7737

Ensures java deprecated notation is paired with javadoc and vice versa.
Adds javadoc deprecation for MecanumControllerCommand, ArmFeedForward,
ElevatorFeedforward, and MecanumDriveMotorVoltages
Fixes wpilibsuite#7736
Supersedes wpilibsuite#7737
@sciencewhiz sciencewhiz requested review from a team as code owners January 27, 2025 04:49
Copy link
Contributor

This PR modifies commands. Please open a corresponding PR in Python Commands and include a link to this PR.

@github-actions github-actions bot added component: command-based WPILib Command Based Library component: wpimath Math library labels Jan 27, 2025
@sciencewhiz
Copy link
Contributor Author

This PR modifies commands. Please open a corresponding PR in Python Commands and include a link to this PR.

MecanumControllerCommand isn't implemented in python, so no PR necessary

Comment on lines +175 to +176
* @deprecated MecanumControllerCommand does not allow for much visibility for troubleshooting.
* Compose HolonomicDriveController within a subystem.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* @deprecated MecanumControllerCommand does not allow for much visibility for troubleshooting.
* Compose HolonomicDriveController within a subystem.
* @deprecated Use {@link MecanumVoltagesConsumer} instead of {@code Consumer<MecanumDriveMotorVoltages}.

The deprecation was added in #6760, and the MecanumVoltagesConsumer overloads are not deprecated. We could deprecate those as well for the in the original codereason, but that would be a separate PR.

Comment on lines +313 to +314
* @deprecated MecanumControllerCommand does not allow for much visibility for troubleshooting.
* Compose HolonomicDriveController within a subystem.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* @deprecated MecanumControllerCommand does not allow for much visibility for troubleshooting.
* Compose HolonomicDriveController within a subystem.
* @deprecated Use {@link MecanumVoltagesConsumer} instead of {@code Consumer<MecanumDriveMotorVoltages>}.

/**
* Represents the motor voltages for a mecanum drive drivetrain.
*
* @deprecated use a fuctional interface intead.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* @deprecated use a fuctional interface intead.
* @deprecated Use {@link MecanumControllerCommand.MecanumVoltagesConsumer}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: command-based WPILib Command Based Library component: wpimath Math library
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[wpimath] ElevatorFeedforward calculate() deprecation is not documented
2 participants