bpo-33649: Add high-level APIs cheat-sheet #9319
Conversation
1st1
requested review from
willingc
and removed request for
gpshead and
rhettinger
Doc/library/asyncio-api-index.rst
Outdated
There was a problem hiding this comment.
I haven't seen the rendered version but, based on the content, I think something like 30/70 might look better.
Also using the simple table markup (http://docutils.sourceforge.net/docs/user/rst/quickref.html#tables) might make the source shorter and more readable (same below).
There was a problem hiding this comment.
Looks pretty good rendered.
There was a problem hiding this comment.
Adjusting to @ezio-melotti's suggested width would shorten the first entry.
There was a problem hiding this comment.
This is pretty much what I expected: it has too much whitespace on the first column and leaves less space for the description (e.g. the first description has to take two lines instead of one).
I think the simple table markup also figures out the column width automatically based on the content (and the list-table probably does the same if you omit the width, unless you want consistency between the tables).
There was a problem hiding this comment.
I think the simple table markup also figures out the column width automatically based on the content (and the list-table probably does the same if you omit the width, unless you want consistency between the tables).
No, it doesn't. The table is formatted this way because I configured the columns to be a 50/50 split, which I experimentally found to look the least awful. Unfortunately, while sphinx allows to set percentages for the table columns' widths it doesn't allow to do so for the table itself. Anyways, I'd like to keep the makup as is in this PR.
There was a problem hiding this comment.
Fair enough.
Just out of curiosity, what did you find awful, and what were you trying to achieve (consistent column width between tables, full width table, others)?
(FWIW, of the two screenshots posted by Carol (thanks!), I prefer the 30/70.)
Doc/library/asyncio-api-index.rst
Outdated
There was a problem hiding this comment.
It is a separate exception that doesn't inherit from it?
|
When you're done making the requested changes, leave the comment: |
There are plenty of links to these classes 2-3 lines around those occurrences. Let's not add too many links. |
6 participants
https://bugs.python.org/issue33649