Fix hidden command documentation (Issue #1178) #1
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.
This PR corrects an outdated NOTE in the "Hidden Command" documentation page.
The existing documentation states:
However, this statement is no longer accurate. Spring Shell does support the
definition of hidden commands via annotation-based configuration.
For example, the following works as expected:
@command(command = "connect", alias = "c", hidden = true)
This annotation correctly hides the command from:
The documentation also includes example snippets that demonstrate using
hidden = true, which contradicts the NOTE.This PR updates the NOTE to reflect the current and correct behavior of the
framework and to avoid confusion for users reading the documentation.
Changes:
hidden.adocCloses spring-projects#1178