RSDK-9884 - support invisible aliases #4783
Open
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.
Updates the
String
method ofAliasStringFlag
to hide aliases, and ensures thatAliasStringFlag
is used consistently fororganization
,location
,machine
, andpart
.Note: I opted to update
AliasStringFlag
rather than creating a newInvisibleAliasStringFlag
type. My reasoning was 1) avoiding excessive type proliferation is a good thing, and 2) the only placesAliasStringFlag
was being used was for org/location/machine/part, so after this PR it wasn't actually being used anywhere. However, if in the future we have a string flag that is required and has aliases that we don't want to hide in the help text, we may have to revisit. Happy to discuss the decision here if there's any pushback.Tested locally to confirm the new help text, and to confirm that despite not appearing in help text, the aliases are still respected.
viam machine part shell
the old way:viam machine part shell
the new way:cc @JessamyT