rustdoc: word wrap CamelCase in the item list table and sidebar#126247
Merged
bors merged 7 commits intorust-lang:masterfrom Jul 30, 2024
Merged
rustdoc: word wrap CamelCase in the item list table and sidebar#126247bors merged 7 commits intorust-lang:masterfrom
bors merged 7 commits intorust-lang:masterfrom
Conversation
Collaborator
Collaborator
|
Some changes occurred in src/tools/compiletest cc @jieyouxu These commits modify the If this was unintentional then you should revert the changes before this PR is merged. |
This comment has been minimized.
This comment has been minimized.
Member
|
I'm not a big fan to this approach. Limiting the width of the item name seems better don't you think? |
Contributor
Author
|
I remember awhile back that @fmease proposed experimenting with wbr to produce “more legible output” The legibility comes from not having line breaks in the middle of words. For example, if the width limit were ten characters, it’s the difference between: vs I suppose that adding a hard width limit doesn’t preclude doing this, so it might be worth doing this experiment anyway. |
Member
|
Fair enough. 👍 |
|
Wouldn't the |
Contributor
Author
|
That's correct, @BradMarr. |
06ce2e0 to
b7f202a
Compare
Collaborator
|
Some changes occurred in GUI tests. |
b7f202a to
a32cb15
Compare
This comment has been minimized.
This comment has been minimized.
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Jul 29, 2024
…-table, r=GuillaumeGomez rustdoc: word wrap CamelCase in the item list table and sidebar This is an alternative to rust-lang#126209. That is, it fixes the issue that affects the very long type names in https://docs.rs/async-stripe/0.31.0/stripe/index.html#structs. This is, necessarily, a pile of nasty heuristics. We need to balance a few issues: - Sometimes, there's no real word break. For example, `BTreeMap` should be `BTree<wbr>Map`, not `B<wbr>Tree<wbr>Map`. - Sometimes, there's a legit word break, but the name is tiny and the HTML overhead isn't worth it. For example, if we're typesetting `TyCtx`, writing `Ty<wbr>Ctx` would have an HTML overhead of 50%. Line breaking inside it makes no sense. # Screenshots | Before | After | | ------ | ----- | |  | 
Member
|
@bors r- needs refmt |
This is an alternative to ee6459d. That is, it fixes the issue that affects the very long type names in https://docs.rs/async-stripe/0.31.0/stripe/index.html#structs. This is, necessarily, a pile of nasty heuristics. We need to balance a few issues: - Sometimes, there's no real word break. For example, `BTreeMap` should be `BTree<wbr>Map`, not `B<wbr>Tree<wbr>Map`. - Sometimes, there's a legit word break, but the name is tiny and the HTML overhead isn't worth it. For example, if we're typesetting `TyCtx`, writing `Ty<wbr>Ctx` would have an HTML overhead of 50%. Line breaking inside it makes no sense.
e277d8e to
25d4152
Compare
Contributor
Author
|
@bors r=GuillaumeGomez |
Collaborator
This comment has been minimized.
This comment has been minimized.
25d4152 to
85b1ddb
Compare
This comment has been minimized.
This comment has been minimized.
This also improves sidebar layout, so instead of
BTreeM
ap
you get this
BTree
Map
Contributor
Author
|
@bors r=GuillaumeGomez |
Collaborator
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
9 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.
This is an alternative to #126209. That is, it fixes the issue that affects the very long type names in https://docs.rs/async-stripe/0.31.0/stripe/index.html#structs.
This is, necessarily, a pile of nasty heuristics. We need to balance a few issues:
Sometimes, there's no real word break. For example,
BTreeMapshould beBTree<wbr>Map, notB<wbr>Tree<wbr>Map.Sometimes, there's a legit word break, but the name is tiny and the HTML overhead isn't worth it. For example, if we're typesetting
TyCtx, writingTy<wbr>Ctxwould have an HTML overhead of 50%. Line breaking inside it makes no sense.Screenshots