bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rollup merge of #128014 - GuillaumeGomez:stab-in-doc-blocks, r=notriddle

Browse source 
Fix stab display in doc blocks

Went across this bug randomly:

![Screenshot from 2024-07-20 22-09-49](https://github.com/user-attachments/assets/89fdf427-b00e-4fcb-9d57-078bcb1bacd9)

With the fixed CSS:

![Screenshot from 2024-07-20 22-10-14](https://github.com/user-attachments/assets/eda9a1a6-6a12-408f-bd3a-25bb3397d163)

r? ```@notriddle```
This commit is contained in:
Jubilee 2024-07-21 17:44:28 -07:00 • committed by GitHub
commit 5bd7525856
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 19 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/librustdoc/html/static/css/rustdoc.css
View file

@ -831,6 +831,10 @@ pre, .rustdoc.src .example-wrap {
background: var(--table-alt-row-background-color); background: var(--table-alt-row-background-color);
} }
.docblock .stab, .docblock-short .stab {
display: inline-block;
}
/* "where ..." clauses with block display are also smaller */ /* "where ..." clauses with block display are also smaller */
div.where { div.where {
white-space: pre-wrap; white-space: pre-wrap;

4
tests/rustdoc-gui/source-code-page-code-scroll.goml
View file

@ -2,7 +2,7 @@
go-to: "file://" + |DOC_PATH| + "/src/test_docs/lib.rs.html" go-to: "file://" + |DOC_PATH| + "/src/test_docs/lib.rs.html"
set-window-size: (800, 1000) set-window-size: (800, 1000)
// "scrollWidth" should be superior than "clientWidth". // "scrollWidth" should be superior than "clientWidth".
assert-property: ("body", {"scrollWidth": 1047, "clientWidth": 800}) assert-property: ("body", {"scrollWidth": 1114, "clientWidth": 800})
// Both properties should be equal (ie, no scroll on the code block). // Both properties should be equal (ie, no scroll on the code block).
assert-property: (".example-wrap .rust", {"scrollWidth": 933, "clientWidth": 933}) assert-property: (".example-wrap .rust", {"scrollWidth": 1000, "clientWidth": 1000})

8
tests/rustdoc-gui/src/test_docs/lib.rs
View file

@ -20,10 +20,10 @@ Also, stop using `bar` as it's <span class="stab deprecated" title="">deprecated
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>. 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> Finally, you can use `quz` only on <span class="stab portability" data-span="1"><code>Unix or x86-64
</span>. </code></span>.
Finally, you can use `quz` only on <span class="stab portability"><code>Unix or x86-64</code> Finally, you can use `quz` only on <span class="stab portability" data-span="2"><code>Unix or x86-64
</span>. </code></span>.
*/ */
use std::convert::AsRef; use std::convert::AsRef;

9
tests/rustdoc-gui/stab-in-doc.goml Normal file
View file

@ -0,0 +1,9 @@
// This test ensure that `stab` elements if used in doc blocks are not breaking the text layout.
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
// We make the window wide enough for the two stabs who are looking into to be on the same line.
set-window-size: (1100, 600)
compare-elements-position: (
".top-doc .docblock span[data-span='1']",
".top-doc .docblock span[data-span='2']",
["y"],
)