Skip to content

Option to show table column descriptions in show_in_notebook() #9660

Closed

Description

@hcferguson

Description

It would be nice to have the ability to reveal the column descriptions in the table headers if they are there. I'd probably put this as the default, but if not, it would be good to at least include it as an option.

Additional context

As far as I can tell the only way to see the column descriptions is with table.info() or by introspecting or saving to a format that saves the metadata. At least one of the print options ought to have the ability to put the descriptions in the header. show_in_notebook and even show_in_browser seem like the simplest solution, since it could be implemented as a keyword option.

Activity

  1. taldcroft commented on Nov 24, 2019

    @taldcroft
    Member

    My main concern on this is that in my experience the "description" tends to be on the long side and so putting it into the table header will generally make the plaintext render of the table useless. However, for HTML-based output, one could imagine having a hover-over on the column name that provides the description if available.

    FYI, the following location is where one might go to add an option to show description in the header:

    if show_unit:

  2. hcferguson commented on Nov 25, 2019

    @hcferguson
    ContributorAuthor

    I like the idea of a hover option.

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

      Issue actions