PEP 11: Switch to a list table #2643
Conversation
The normal ReST table format is confusing if the lines are long and wrapped. The list-table directive makes tables from nested lists, which is friendly for reviewers on smaller screens if lines get long again, and it also makes nicer diffs when column sizes need to change. This also adds back handy links to individual buildbots, in effect reverting commit a8a7bd5. One disadvantage is that list-table doesn't support "rowspan", so the `aarch64-unknown-linux-gnu` triplet is repeated.
Looks good. Two additional suggestions -- you could make the Tier 1 table a list table for consistency, and you could make the "Details/Notes" column also have a sub-list, similar to the new format for contacts.
I suggested changing "Details" to "Compiler" as it's not entirely clear what the details are on, as a layman -- if I've gotten the terminology wrong please correct me.
A
| :widths: auto | ||
|
|
||
| * - Target Triple | ||
| - Details |
There was a problem hiding this comment.
"Details" and "Notes" are quite vague -- the entries seem all to be C compilers for the target triples.
| - Details | |
| - Compiler |
There was a problem hiding this comment.
If you want to be really specific, the info is C compiler and libc implementation. So if you really want to break it down we would have those two columns plus a Notes field for e.g. "Raspberry Pi OS".
| :widths: auto | ||
|
|
||
| * - Target Triple | ||
| - Details |
There was a problem hiding this comment.
Same reason as above, although "Rasberry Pi OS" is an outlier.
| - Details | |
| - Compiler |
|
|
||
| * - Target Triple | ||
| - Details | ||
| - Buildbot |
There was a problem hiding this comment.
I purposefully pulled out the buildbot links as those builder numbers are not stable, so I would prefer to not add them back in.
| :widths: auto | ||
|
|
||
| * - Target Triple | ||
| - Details |
There was a problem hiding this comment.
If you want to be really specific, the info is C compiler and libc implementation. So if you really want to break it down we would have those two columns plus a Notes field for e.g. "Raspberry Pi OS".
@brettcannon, here is a proposal for different source formatting for PEP-11 tables. I find it better, but feel free to close if you disagree.
The normal ReST table format is confusing if the lines are long and wrapped, like when they included handy links to individual buildbots. (I was surprised when they got removed in a8a7bd5, without a PR...)
The list-table directive makes tables from nested lists, which is friendly for reviewers on smaller screens if lines get long again, and it also makes nicer diffs when column sizes need to change.
One disadvantage is that list-table doesn't support "rowspan", so the
aarch64-unknown-linux-gnutriplet is repeated.On the other hand, buildbot links can be added back, and there's no soft limit to more Contacts.