doc: fix layout of tables within parameter lists #10274
Conversation
|
pinging @doraf who is our web design expert. |
|
CSS seems fine. However, the legibility issues may be better resolved by pulling this info out of a table and into a definition list. |
|
Not sure, if a definition list is more readable, at least as long as it stays below Note, that the text above the table should be left aligned with the table. Its additional indentation is due to #10161. |
cdc54e7 to
06d2793
Compare
|
@jklymak Thanks for the remark. I checked that now and in fact, there are some rare cases of other tables which are affected, e.g. (unfortunately, I've just added this table recently myself ...) I've now augmented the code to add a class attribute |
|
|
cda5b22 to
912eb50
Compare
PR Summary
Since using numpydoc, it's quite common to insert the interpolated parameter list into the "Additional Parameters" section. The css layout was not specifically great for this, because it was assuming a top-level table.
This PR adds dedicated css for tables in numpydoc field descriptions.
Before:
After:
Note: #10161 also targets the layout of interpolated parameter lists. However, the two issues are independent. The effect of #10161 is still visible in the above screenshots. Also, this PR does not influence a possible solution of #10161.