Update Shuffleboard docs to recommend lambda functions for dynamic data #3129
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replaces the getEntry()/setDouble() pattern with the recommended addNumber()/addString()/addBoolean() lambda/callable pattern for sending dynamic data to Shuffleboard. Adds important note clarifying when to use each API. Fixes wpilibsuite#2617
|
Given that shuffleboard API is going away in 2027 and the fact there's been lots of feedback about people not liking lambdas, I'm not sure this one is worth fixing. |
|
Up to you, that is fine. I would say lets start going through the issues and start weeding out the ones we don't want to do. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Updates the Shuffleboard documentation to recommend using lambda functions (Java) or callables (Python) with
addNumber(),addString(), andaddBoolean()methods for sending dynamic data, rather than thegetEntry()andsetDouble()/setString()pattern.Changes
getEntry()pattern with lambda/callable patternaddNumber()with lambdaaddNumber()with lambdagetEntry()API should only be used for reading data from Shuffleboard (sliders, text fields, etc.), not for sending dataFixes #2617