docs icon indicating copy to clipboard operation
docs copied to clipboard

Guidelines for using tables

Open peterdamian opened this issue 6 years ago • 5 comments

Tables can be a useful way of presenting some types of data but Document Guidelines says nothing about them. Perhaps this is because tables are the elephant in the ReST room. Even simple tables can be awkward to create. Inserting raw HTML is an alternative but the 'raw' directive is output-specific. This objection may be irrelevant if Mattermost doesn't care about output formats other than HTML. In any case, some guidelines should be provided.

peterdamian avatar Sep 19 '17 21:09 peterdamian

Hi @peterdamian

I see you've been busy ;) Thanks again for the feedback!

Would you be interested in submitting a pull request to add a section on Tables to the Document Guidelines?

lindy65 avatar Sep 20 '17 11:09 lindy65

Hi @lindy65,

I'd like to do this but only after I've worked with ReST for a while--in a month or so.

peterdamian avatar Sep 20 '17 13:09 peterdamian

Sounds good, thanks @peterdamian!

lindy65 avatar Sep 21 '17 09:09 lindy65

Hilarious joke @peterdamian (re: elephant in the ReST room).

shieldsjared avatar Oct 07 '17 13:10 shieldsjared

Totally agree that tables can be tricky to work with. I've noted that the style guide doesn't mention this and I'm assigning this to myself in order to add a section with table examples that can be copied and pasted into documentation. Thanks for raising this!

justinegeffen avatar Jan 14 '22 07:01 justinegeffen