k1LoW / tbls

tbls is a CI-Friendly tool for document a database, written in Go.
MIT License
3.32k stars 163 forks source link

Show table comments for related tables of View. #587

Closed majimaccho closed 1 month ago

majimaccho commented 1 month ago

Hi. I'm always thankful for this great library tbls!

I have an idea it could improve user experience about View thing.

Currently view's Referenced Tables section is looking like below.

## Referenced Tables

- [shema.table_name](shema.table_name.md)

I suppose it could be better to show table in format of other sections showing tables like below.

## Referenced Tables

| name | columns |  comments | type | 
| --- | --- | --- | --- |
| {name} | {columns} |  {comments} | {type} | 

Let me know, what you think. Thank you! ;)

k1LoW commented 1 month ago

Hi @majimaccho!

Looks good.

If adopted, the Related Tables section might be better placed below the Columns section. This is because there will be more information in the Related Tables section.

majimaccho commented 1 month ago

Thanks! I'll work on this.

If adopted, the Related Tables section might be better placed below the Columns section. This is because there will be more information in the Related Tables section.

I got this point 👍