[commands] Deprecate proxy supplier constructor (#6553)

This commit is contained in:
DeltaDizzy
2024-04-29 23:11:29 -05:00
committed by GitHub
parent c71db8ea9c
commit a9cfd0d0f9
6 changed files with 51 additions and 7 deletions

View File

@@ -7,6 +7,7 @@
#include <memory>
#include <wpi/FunctionExtras.h>
#include <wpi/deprecated.h>
#include "frc2/command/Command.h"
#include "frc2/command/CommandHelper.h"
@@ -36,8 +37,16 @@ class ProxyCommand : public CommandHelper<Command, ProxyCommand> {
* DeferredCommand} instead.
*
* @param supplier the command supplier
* @deprecated This constructor's similarity to {@link DeferredCommand} is
* confusing and opens potential footguns for users who do not fully
* understand the semantics and implications of proxying, but who simply want
* runtime construction. Users who do know what they are doing and need a
* supplier-constructed proxied command should instead proxy a DeferredCommand
* using the <code>AsProxy</code> decorator.
* @see DeferredCommand
*/
WPI_IGNORE_DEPRECATED
[[deprecated("Proxy a DeferredCommand instead")]]
explicit ProxyCommand(wpi::unique_function<Command*()> supplier);
/**
@@ -49,9 +58,17 @@ class ProxyCommand : public CommandHelper<Command, ProxyCommand> {
* DeferredCommand} instead.
*
* @param supplier the command supplier
* @deprecated This constructor's similarity to {@link DeferredCommand} is
* confusing and opens potential footguns for users who do not fully
* understand the semantics and implications of proxying, but who simply want
* runtime construction. Users who do know what they are doing and need a
* supplier-constructed proxied command should instead proxy a DeferredCommand
* using the <code>AsProxy</code> decorator.
* @see DeferredCommand
*/
[[deprecated("Proxy a DeferredCommand instead")]]
explicit ProxyCommand(wpi::unique_function<CommandPtr()> supplier);
WPI_UNIGNORE_DEPRECATED
/**
* Creates a new ProxyCommand that schedules the given command when