Movatterモバイル変換

Skip to content

symfony/symfony-docsPublic

NotificationsYou must be signed in to change notification settings
Fork5.2k
Star2.3k

[Console] Document the`TreeHelper`#20786

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged

javiereguiluz merged 1 commit intosymfony:7.3fromsmnandre:console-tree-helper

Mar 24, 2025

Merged

[Console] Document the`TreeHelper`#20786

javiereguiluz merged 1 commit intosymfony:7.3fromsmnandre:console-tree-helper

Mar 24, 2025

Conversation

smnandre

Copy link

Member

smnandre commentedMar 21, 2025•
edited
Loading

Q	A
Feature PR	symfony/symfony#59588
PR author(s)	@smnandre
Merged in	7.3
Doc Issue	Fix#20692

@carsonbot

carsonbot added Status: Needs Review Console labels

@carsonbot

carsonbot added this to the7.3 milestone

OskarStark

OskarStark reviewed

View reviewed changes

components/console/helpers/tree.rst


		.. code-block:: text

		🔵 🟣 🟡 src

Copy link

Contributor

OskarStarkMar 21, 2025

Choose a reason for hiding this comment

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

I love this example ❤️

OskarStark

OskarStark reviewed

View reviewed changes

components/console/helpers/tree.rst

		🔵 🟢 🟢 🟠 🟡 DefaultController.php
		🔵 🟢 🟠 🟡 Kernel.php
		🔵 🟠 🟡 templates
		🔵 🔴 🟠 🟡 base.html.twig

Copy link

Contributor

OskarStarkMar 21, 2025

Choose a reason for hiding this comment

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

Please add a versionadded directive below, like for other new features, thanks

Copy link

MemberAuthor

smnandreMar 21, 2025

Choose a reason for hiding this comment

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

The whole page is about the new tree helper, should i put the versionadded at the very start of the page ?

Copy link

Contributor

alamiraultMar 21, 2025

Choose a reason for hiding this comment

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

I think yes, and add it also inconsole/style.rst after the new methods

Copy link

Contributor

OskarStarkMar 21, 2025

Choose a reason for hiding this comment

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

Yes please, so that a reader knows, since when this can be used

Copy link

MemberAuthor

smnandreMar 21, 2025

Choose a reason for hiding this comment

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

Would this work ? (last changes)

@smnandre

smnandre requested a review fromOskarStark

March 22, 2025 02:35

OskarStark

OskarStark reviewed

View reviewed changes

components/console/helpers/tree.rst OutdatedShow resolvedHide resolved

OskarStark

OskarStark approved these changes

View reviewed changes

@carsonbot

carsonbot added Status: Reviewed and removed Status: Needs Review labels

@OskarStark

Copy link

Contributor

OskarStark commentedMar 22, 2025

Link to the code PR is not working in the PR header

@OskarStark

OskarStark changed the title~~[Console] Document the TreeHelper~~[Console] Document theTreeHelper

@smnandre

Copy link

MemberAuthor

smnandre commentedMar 24, 2025

Link to the code PR is not working in the PR header

Fixed sorry

@smnandre

@javiereguiluz

[Console] Document theTreeHelper

d9a48be

@javiereguiluz

javiereguiluz force-pushed theconsole-tree-helper branch fromcfb9dad tod9a48beCompare

March 24, 2025 08:41

@javiereguiluz

javiereguiluz merged commitb39f1c1 intosymfony:7.3

2 of 3 checks passed

@javiereguiluz

Copy link

Member

javiereguiluz commentedMar 24, 2025•
edited
Loading

Thanks Simon for contributing this nice feature and for providing such detailed docs for it.

While merging I did some tweaks (seea0758ac):

Updated the intro to add some examples of when to use this
Added a full code example of using this inside a console command. This is important because if you copy+paste the examples, it won't work (e.g. the$io variable is not defined). I only added this in the first example to avoid boring repetition
Changedtext byterminal in the code examples to display the rendered output in a terminal-like window.

@smnandre

Copy link

MemberAuthor

smnandre commentedMar 25, 2025

Thank you very much@javiereguiluz !!

@javiereguiluz

javiereguiluz mentioned this pull request

[Console] Tweak the tree helper#20825

Merged

OskarStark added a commit that referenced this pull request

@OskarStark

minor#20825[Console] Tweak the tree helper (javiereguiluz)

104552b

This PR was merged into the 7.3 branch.Discussion----------[Console] Tweak the tree helperThis continues#20786 to do some minor tweaks.1) We now display a full example of how to select the built-in styles.2) The listing of built-in styles now provides more details.Before, it was rendered like this (seehttps://symfony.com/doc/7.3/components/console/helpers/tree.html)![](https://github.com/user-attachments/assets/420337e2-686d-44c2-b17e-20cff771ea5e)-----I think it's fine to remove the `:method:` link because it doesn't provide direct links to the method, just to the class. So, all the previous `:methods:` links were in practice the same link.Commits-------5844ee6 [Console] Tweak the tree helper

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Labels

Console Status: Reviewed

5 participants

@smnandre

@OskarStark

@javiereguiluz

@alamirault

@carsonbot

[8]ページ先頭

©2009-2025 Movatter.jp