rustdoc: clean up docblock table CSS #105442
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
* The rule `display: block` had no noticeable effect. Technically, because markdown tables have a tbody and thead, they get wrapped in an [anonymous table box] in the CSS tree, nested within the `<table>` element's block layout box. This rule was added in rust-lang#87230 to make the table side-scrolling, but this same issue was doubly fixed in rust-lang#88742 by wrapping it in an explicit `<div>` tag. Since accessibility advocates recommend the wrapper div over marking the table as `display: block`, we'll stick with that. https://adrianroselli.com/2020/11/under-engineered-responsive-tables.html * The rule `width: calc(100% - 2px)` had no visible effect, because the anonymous table box was not affected. * The style is tweaked to basically be the same style GitHub uses. In particular, it adds zebra stripes, and removes dotted borders. [anonymous table box]: https://www.w3.org/TR/CSS2/tables.html#anonymous-boxes
| r? @jsha (rustbot has picked a reviewer for you, use r? to override) |
rustbot added S-waiting-on-review | Some changes occurred in HTML/CSS themes. A change occurred in the Ayu theme. cc @Cldfire Some changes occurred in HTML/CSS/JS. cc @GuillaumeGomez, @Folyd, @jsha |
| Looks good to me but let's wait for @jsha to check as well. Please add a rustdoc-gui test for the tables. |
notriddle force-pushed the notriddle/docblock-table-css branch from 522a7b0 to 6c5e02a Compare notriddle force-pushed the notriddle/docblock-table-css branch from 6c5e02a to 34700f6 Compare 
GuillaumeGomez approved these changes Dec 8, 2022
| Thanks! @bors r+ rollup |
bors added S-waiting-on-bors 
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 9, 2022
…iaskrgr Rollup of 10 pull requests Successful merges: - rust-lang#105216 (Remove unused GUI test) - rust-lang#105245 (attempt to clarify align_to docs) - rust-lang#105387 (Improve Rustdoc scrape-examples UI) - rust-lang#105389 (Enable profiler in dist-powerpc64le-linux) - rust-lang#105427 (Dont silently ignore rustdoc errors) - rust-lang#105442 (rustdoc: clean up docblock table CSS) - rust-lang#105443 (Move some queries and methods) - rust-lang#105455 (use the correct `Reveal` during validation) - rust-lang#105470 (Clippy: backport ICE fix before beta branch) - rust-lang#105474 (lib docs: fix typo) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Aaron1011 pushed a commit to Aaron1011/rust that referenced this pull request Jan 6, 2023
…-css, r=GuillaumeGomez rustdoc: clean up docblock table CSS # Preview http://notriddle.com/notriddle-rustdoc-demos/table-2/test_dingus/fn.test.html # Before  # After  # Details * The rule `display: block` had no noticeable effect. Technically, because markdown tables have a tbody and thead, they get wrapped in an [anonymous table box] in the CSS tree, nested within the `<table>` element's block layout box. This rule was added in rust-lang#87230 to make the table side-scrolling, but this same issue was doubly fixed in rust-lang#88742 by wrapping it in an explicit `<div>` tag. Since accessibility advocates recommend the wrapper div over marking the table as `display: block`, we'll stick with that. https://adrianroselli.com/2020/11/under-engineered-responsive-tables.html * The rule `width: calc(100% - 2px)` had no visible effect, because the anonymous table box was not affected. * The style is tweaked to basically be the same style GitHub uses. In particular, it adds zebra stripes, and removes dotted borders. https://rust-lang.zulipchat.com/#narrow/stream/266220-rustdoc/topic/Markdown.20table.20styling [anonymous table box]: https://www.w3.org/TR/CSS2/tables.html#anonymous-boxes
Aaron1011 pushed a commit to Aaron1011/rust that referenced this pull request Jan 6, 2023
…iaskrgr Rollup of 10 pull requests Successful merges: - rust-lang#105216 (Remove unused GUI test) - rust-lang#105245 (attempt to clarify align_to docs) - rust-lang#105387 (Improve Rustdoc scrape-examples UI) - rust-lang#105389 (Enable profiler in dist-powerpc64le-linux) - rust-lang#105427 (Dont silently ignore rustdoc errors) - rust-lang#105442 (rustdoc: clean up docblock table CSS) - rust-lang#105443 (Move some queries and methods) - rust-lang#105455 (use the correct `Reveal` during validation) - rust-lang#105470 (Clippy: backport ICE fix before beta branch) - rust-lang#105474 (lib docs: fix typo) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Preview
http://notriddle.com/notriddle-rustdoc-demos/table-2/test_dingus/fn.test.html
Before
After
Details
The rule
display: blockhad no noticeable effect. Technically, because markdown tables have a tbody and thead, they get wrapped in an anonymous table box in the CSS tree, nested within the<table>element's block layout box.This rule was added in Fix docblock <table> overflow #87230 to make the table side-scrolling, but this same issue was doubly fixed in Fix table in docblocks #88742 by wrapping it in an explicit
<div>tag. Since accessibility advocates recommend the wrapper div over marking the table asdisplay: block, we'll stick with that.https://adrianroselli.com/2020/11/under-engineered-responsive-tables.html
The rule
width: calc(100% - 2px)had no visible effect, because the anonymous table box was not affected.The style is tweaked to basically be the same style GitHub uses. In particular, it adds zebra stripes, and removes dotted borders.
https://rust-lang.zulipchat.com/#narrow/stream/266220-rustdoc/topic/Markdown.20table.20styling