Skip to content

Conversation

@axaggelpapa30
Copy link
Owner

This PR corrects an outdated NOTE in the "Hidden Command" documentation page.

The existing documentation states:

NOTE: Defining hidden commands is not supported with annotation based configuration.

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 help listing
  • the help page for unknown commands
  • command completion in interactive mode
  • bash completion

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:

  • Updated the NOTE block in hidden.adoc
  • Clarified that annotation-based hidden commands are supported
  • Added accurate wording and an example reference

Closes spring-projects#1178

Corrected outdated NOTE: annotation-based hidden commands are supported using `@Command(hidden = true)`.

Signed-off-by: axaggelpapa30 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

"Hidden" documentation error

2 participants