tbls icon indicating copy to clipboard operation
tbls copied to clipboard

Better handling of table descriptions on README vs. detail page.

Open mjpieters opened this issue 4 years ago • 1 comments

Currently, the README.md file lists all tables with their full table comment.

I'm putting a lot of info in some of my table descriptions, including SQL code blocks. These render rather badly in the comment column of the central Tables table, which treats markdown just a little different.

Perhaps the Tables table should only use the first paragraph of each table description.

E.g. the description

Foo widgets

Tracks Foo widget metadata as the frobnar twiddles with the status and inserts more information.

Because there may be redundant, duplicated rows with different timestamps in this table, please use a window query to consolidate adjacent rows:

-- Some elaborate sample query

would only take the text up to the first double newline and so the comment in the Tables comments column becomes:

Foo widgets

and only the detail page shows the remainder.

mjpieters avatar Apr 22 '20 17:04 mjpieters

Hi @mjpieters. I know it's very late, but I implemented it in #325 .

Thank you!

k1LoW avatar Nov 13 '21 10:11 k1LoW