Skip to content

Commit

Permalink
Rollup merge of rust-lang#92801 - jsha:overflow-wrap, r=GuillaumeGomez
Browse files Browse the repository at this point in the history
Enable wrapping words by default

Faced with a very long word, browsers will let it overflow its
box horizontally rather than break it in the middle. We essentially
never want that behavior. We would rather break the word and keep it
inside its horizontal limits. So we apply a default overflow-wrap:
break-word/anywhere to the document as a while.

In some contexts we would rather add a horizontal scrollbar (code
blocks), or elide the excess text with an ellipsis (sidebar). Those
still work as expected.

Fixes rust-lang#92771

[Some related discussion](https://rust-lang.zulipchat.com/#narrow/stream/266220-rustdoc/topic/wrap.20.2F.20overflow.20.2F.20scroll) and a related issue: rust-lang#92421.

Demo: https://rustdoc.crud.net/jsha/overflow-wrap/std/iter/trait.Iterator.html#method.try_find

r? ``@GuillaumeGomez``
  • Loading branch information
matthiaskrgr authored Jan 17, 2022
2 parents 4de63e7 + 4d5a6c9 commit 51aa20d
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions src/librustdoc/html/static/css/rustdoc.css
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,12 @@ body {
font: 1rem/1.4 "Source Serif 4", NanumBarunGothic, serif;
margin: 0;
position: relative;
/* We use overflow-wrap: break-word for Safari, which doesn't recognize
`anywhere`: https://developer.mozilla.org/en-US/docs/Web/CSS/overflow-wrap */
overflow-wrap: break-word;
/* Then override it with `anywhere`, which is required to make non-Safari browsers break
more aggressively when we want them to. */
overflow-wrap: anywhere;

-webkit-font-feature-settings: "kern", "liga";
-moz-font-feature-settings: "kern", "liga";
Expand Down Expand Up @@ -446,6 +452,7 @@ nav.sub {
text-align: center;
border-bottom: 1px solid;
overflow-wrap: break-word;
overflow-wrap: anywhere;
word-wrap: break-word; /* deprecated */
word-break: break-word; /* Chrome, non-standard */
}
Expand Down Expand Up @@ -576,6 +583,7 @@ nav.sub {
}

.docblock-short {
overflow-wrap: break-word;
overflow-wrap: anywhere;
}
.docblock-short p {
Expand Down Expand Up @@ -641,6 +649,7 @@ nav.sub {
flex-grow: 1;
margin: 0px;
padding: 0px;
overflow-wrap: break-word;
overflow-wrap: anywhere;
}

Expand Down Expand Up @@ -669,6 +678,7 @@ nav.sub {
margin: .5em 0;
width: calc(100% - 2px);
overflow-x: auto;
overflow-wrap: normal;
display: block;
}

Expand Down Expand Up @@ -1495,6 +1505,7 @@ pre.rust {
padding: 4px 8px;
text-align: center;
background: rgba(0,0,0,0);
overflow-wrap: normal;
}

#theme-choices > button:not(:first-child) {
Expand Down Expand Up @@ -2099,9 +2110,14 @@ details.rustdoc-toggle[open] > summary.hideme::after {
}

.docblock code {
overflow-wrap: break-word;
overflow-wrap: anywhere;
}

.docblock table code {
overflow-wrap: normal;
}

.sub-container {
flex-direction: column;
}
Expand Down

0 comments on commit 51aa20d

Please sign in to comment.