[Console] Document the TreeHelper
#20786
Conversation
|
|
||
| .. code-block:: text | ||
|
|
||
| 🔵 🟣 🟡 src |
| 🔵 🟢 🟢 🟠 🟡 DefaultController.php | ||
| 🔵 🟢 🟠 🟡 Kernel.php | ||
| 🔵 🟠 🟡 templates | ||
| 🔵 🔴 🟠 🟡 base.html.twig |
There was a problem hiding this comment.
Please add a versionadded directive below, like for other new features, thanks
There was a problem hiding this comment.
The whole page is about the new tree helper, should i put the versionadded at the very start of the page ?
There was a problem hiding this comment.
I think yes, and add it also in console/style.rst after the new methods
There was a problem hiding this comment.
Yes please, so that a reader knows, since when this can be used
There was a problem hiding this comment.
Would this work ? (last changes)
|
Link to the code PR is not working in the PR header |
OskarStark
changed the title
TreeHelper
Fixed sorry |
javiereguiluz
force-pushed
the
console-tree-helper
branch
from
cfb9dad to
d9a48be
Compare
|
Thanks Simon for contributing this nice feature and for providing such detailed docs for it. While merging I did some tweaks (see a0758ac):
|
|
Thank you very much @javiereguiluz !! |
This PR was merged into the 7.3 branch. Discussion ---------- [Console] Tweak the tree helper This 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 (see https://symfony.com/doc/7.3/components/console/helpers/tree.html)  ----- 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
fix #20692