Skip to content

[Console] symfony-style-guide Table style is not documented #20943

Closed
@alamirault

Description

@alamirault
Contributor

While reviewing #20941, is saw there is a Table style named symfony-style-guide but it's not documented.

Output is

 --------------- -------------------------- ------------------ 
  ISBN            Title                      Author            
 --------------- -------------------------- ------------------ 
  99921-58-10-7   Divine Comedy              Dante Alighieri   
  9971-5-0210-0   A Tale of Two Cities       Charles Dickens   
  960-425-059-0   The Lord of the Rings      J. R. R. Tolkien  
  80-902734-1-6   And Then There Were None   Agatha Christie   
 --------------- -------------------------- ------------------ 

https://github.com/symfony/symfony/blob/6b4f603edbd2bee7d340bdb6e57cf2b9c656096b/src/Symfony/Component/Console/Helper/Table.php#L916

Introduced by this commit symfony/symfony@96b4210

Probably related to #4265 ?

Should we document this style ?
Or should it be deprecated in codebase ? (I can make PR)

Activity

javiereguiluz

javiereguiluz commented on May 13, 2025

@javiereguiluz
Member

Thanks Antoine. I wasn't aware of this.

  • I wouldn't document this in the Table helper page, because this is related to Symfony Style and I don't think we should document both. You either use SymfonyStyle (no control but everything is done for you) or the helpers (full control but requires work)
  • About removing this from code ... I guess this style is used by the SymfonyStyle method to render the tables, so we can't remove it
alamirault

alamirault commented on Jun 1, 2025

@alamirault
ContributorAuthor

Indeed SymfonyStyleuse it and didn't see it.
This table still can maybe be deprecated and moved to SymfonyStyle.
But it's not a documentation issue

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @javiereguiluz@alamirault@carsonbot

        Issue actions

          [Console] `symfony-style-guide` Table style is not documented · Issue #20943 · symfony/symfony-docs