Skip to content

[Console] Document the ability to set aliases and hidden status via command name #21166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jul 1, 2025
Merged

[Console] Document the ability to set aliases and hidden status via command name #21166

merged 1 commit into from
Jul 1, 2025
+49 −2

Conversation

OskarStark
Copy link
Contributor

  • Add documentation for the pipe syntax to define command aliases
  • Document how to make commands hidden using the | prefix
  • Show examples for both #[AsCommand] attribute and constructor usage
  • Include version annotation for Symfony 7.4

Fix #21070

@carsonbot carsonbot added this to the 7.4 milestone Jul 1, 2025
@OskarStark OskarStark marked this pull request as draft July 1, 2025 08:45
@OskarStark OskarStark force-pushed the document-console-command-aliases branch 4 times, most recently from fee6f46 to 916621f Compare July 1, 2025 08:53
@OskarStark OskarStark marked this pull request as ready for review July 1, 2025 08:53
@OskarStark OskarStark requested a review from javiereguiluz July 1, 2025 08:53
@carsonbot carsonbot changed the title Document the ability to set aliases and hidden status via command name [Console] Document the ability to set aliases and hidden status via command name Jul 1, 2025
javiereguiluz
javiereguiluz approved these changes Jul 1, 2025
View reviewed changes
Copy link
Member

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Oskar!

Note that we're pausing all merges on Console docs until #20932 is completed.

@OskarStark @javiereguiluz
Document the ability to set aliases and hidden status via command name
f5ca9c5 
- Add documentation for command aliases using pipe syntax in console.rst
- Document how to make commands hidden using the `|` prefix in hide_commands.rst
- Show examples for the #[AsCommand] attribute
- Include version annotations for Symfony 7.4
- Ensure lines are within 80 character limit
@javiereguiluz javiereguiluz force-pushed the document-console-command-aliases branch from 916621f to f5ca9c5 Compare July 1, 2025 10:55
@javiereguiluz
Copy link
Member

Thanks Oskar.

@javiereguiluz javiereguiluz merged commit 71b1c5e into symfony:7.4 Jul 1, 2025
3 checks passed
This was referenced Jul 1, 2025
Closed
Merged
OskarStark added a commit that referenced this pull request Jul 1, 2025
@OskarStark
minor #21170 [Console] Update the hidden command doc when using the p…
c4a571f 
…ipe syntax (javiereguiluz)

This PR was merged into the 7.4 branch.

Discussion
----------

[Console] Update the hidden command doc when using the pipe syntax

I propose these minor tweaks after merging #21166.

I removed the `Hidden commands behave the same as...` phrase because it's already explained at the beginning of the article.

Commits
-------

fbf5080 [Console] Update the hidden command doc when using the pipe syntax
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@javiereguiluz javiereguiluz javiereguiluz approved these changes

Assignees
No one assigned
Labels
Console Status: Reviewed
Projects
None yet
Milestone
7.4
Development

Successfully merging this pull request may close these issues.
3 participants
@OskarStark @javiereguiluz @carsonbot