diff options
| author | Yuki Okushi <jtitor@2k36.org> | 2022-09-22 09:03:56 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-22 09:03:56 +0900 |
| commit | 9aa3180dfc77771d9820f84c023f3689e8cad6e8 (patch) | |
| tree | fdb832766b89e68186fce22719819440ffb498be /src | |
| parent | 3c6dbf911e4768f867596470ce0c8315cefa7825 (diff) | |
| parent | 6069f71e6c6d40bf72a7751450d91fa9b91ba6fa (diff) | |
| download | rust-9aa3180dfc77771d9820f84c023f3689e8cad6e8.tar.gz rust-9aa3180dfc77771d9820f84c023f3689e8cad6e8.zip | |
Rollup merge of #102100 - GuillaumeGomez:stab-in-docblocks, r=notriddle
Prevent usage of .stab elements to create scrollable areas in doc blocks Fixes #101874. You can test it online [here](https://rustdoc.crud.net/imperio/stab-in-doblocks/foo/index.html). r? `@notriddle`
Diffstat (limited to 'src')
| -rw-r--r-- | src/librustdoc/html/static/css/rustdoc.css | 6 | ||||
| -rw-r--r-- | src/test/rustdoc-gui/check-stab-in-docblock.goml | 21 | ||||
| -rw-r--r-- | src/test/rustdoc-gui/src/test_docs/lib.rs | 18 |
3 files changed, 45 insertions, 0 deletions
diff --git a/src/librustdoc/html/static/css/rustdoc.css b/src/librustdoc/html/static/css/rustdoc.css index ec00dabbf43..f21179ec558 100644 --- a/src/librustdoc/html/static/css/rustdoc.css +++ b/src/librustdoc/html/static/css/rustdoc.css @@ -1088,6 +1088,12 @@ so that we can apply CSS-filters to change the arrow color in themes */ margin-right: 0.3rem; } +/* This is to prevent the `.stab` elements to overflow the .docblock elements. */ +.docblock .stab { + padding: 0 0.125em; + margin-bottom: 0; +} + /* Black one-pixel outline around emoji shapes */ .emoji { text-shadow: diff --git a/src/test/rustdoc-gui/check-stab-in-docblock.goml b/src/test/rustdoc-gui/check-stab-in-docblock.goml new file mode 100644 index 00000000000..7f965ada594 --- /dev/null +++ b/src/test/rustdoc-gui/check-stab-in-docblock.goml @@ -0,0 +1,21 @@ +// This test checks that using `.stab` attributes in `.docblock` elements doesn't +// create scrollable paragraphs. +goto: file://|DOC_PATH|/test_docs/index.html +// Needs the text to be display to check for scrollable content. +show-text: true +size: (786, 600) +// Confirms that there 3 paragraphs. +assert-count: (".top-doc .docblock p", 3) +// Checking that there is no scrollable content. +assert-property: ( + ".top-doc .docblock p:nth-of-type(1)", + {"scrollHeight": "120", "clientHeight": "120", "scrollWidth": "502", "clientWidth": "502"}, +) +assert-property: ( + ".top-doc .docblock p:nth-of-type(2)", + {"scrollHeight": "48", "clientHeight": "48", "scrollWidth": "502", "clientWidth": "502"}, +) +assert-property: ( + ".top-doc .docblock p:nth-of-type(3)", + {"scrollHeight": "48", "clientHeight": "48", "scrollWidth": "502", "clientWidth": "502"}, +) diff --git a/src/test/rustdoc-gui/src/test_docs/lib.rs b/src/test/rustdoc-gui/src/test_docs/lib.rs index e6177ff84b4..1c066206c1f 100644 --- a/src/test/rustdoc-gui/src/test_docs/lib.rs +++ b/src/test/rustdoc-gui/src/test_docs/lib.rs @@ -6,6 +6,24 @@ #![feature(rustdoc_internals)] #![feature(doc_cfg)] +/*! +Enable the feature <span class="stab portability"><code>some-feature</code></span> to enjoy +this crate even more! +Enable the feature <span class="stab portability"><code>some-feature</code></span> to enjoy +this crate even more! +Enable the feature <span class="stab portability"><code>some-feature</code></span> to enjoy +this crate even more! + +Also, stop using `bar` as it's <span class="stab deprecated" title="">deprecated</span>. +Also, stop using `bar` as it's <span class="stab deprecated" title="">deprecated</span>. +Also, stop using `bar` as it's <span class="stab deprecated" title="">deprecated</span>. + +Finally, you can use `quz` only on <span class="stab portability"><code>Unix or x86-64</code> +</span>. +Finally, you can use `quz` only on <span class="stab portability"><code>Unix or x86-64</code> +</span>. +*/ + use std::convert::AsRef; use std::fmt; |
