Update rustdoc.css #126209

BradMarr · 2024-06-09T21:52:49Z

fixes #120595

removing this selector fixes weird wrapping in certain pages like https://docs.rs/async-stripe/0.31.0/stripe/index.html#structs

rustbot · 2024-06-09T21:52:56Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @GuillaumeGomez (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

rustbot · 2024-06-09T21:52:58Z

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @jsha

GuillaumeGomez · 2024-06-09T21:59:36Z

This indeed seems to fix the issue, thanks!

Please add a test in tests/rustdoc-gui to ensure this bug won't appear again later on. If you need help to write the test, don't hesitate to ask!

BradMarr · 2024-06-09T22:26:56Z

I'm not familiar with the test system and don't know I could prevent this issue from occurring in the future. The issue was simply that the property was spread to an element it shouldn't have been so I don't know if a test could detect a problem in the future without knowing the intention of the programmer. I'm very new to this though and could be completely incorrect.

BradMarr · 2024-06-09T23:06:41Z

I'm lost as to how an offset error would occur when my only change was to the overflow-wrap.

rustbot · 2024-06-10T00:01:25Z

There are merge commits (commits with multiple parents) in your changes. We have a no merge policy so these commits will need to be removed for this pull request to be merged.

You can start a rebase with the following commands:

$ # rebase
$ git pull --rebase https://github.com/rust-lang/rust.git master
$ git push --force-with-lease

The following commits are merge commits:

44263c6

notriddle · 2024-06-10T00:28:25Z

I don't think that this is a good fix. The problem is that it improves the async-stripe API, but it makes other APIs look worse. For example, this is what std::marker looks like in Firefox. First without the change, then with it.

Before

After

BradMarr · 2024-06-10T02:17:48Z

maybe we could do a minimum width along with the default method so that it only makes the lines overlap if it would otherwise create the vertical line bug @notriddle

notriddle · 2024-06-10T03:14:39Z

Maybe we can automatically insert  tags between CamelCase and snake_case words?

BradMarr · 2024-06-10T15:59:22Z

That would require parsing through all of the words, I think maybe giving each of the .item-table>li>.item-name a max width of half of the width of item-table would allow for overflow of the item-name but only if it would otherwise cause a bug

BradMarr · 2024-06-10T16:23:42Z

How does that commit look?

src/librustdoc/html/static/css/rustdoc.css

GuillaumeGomez · 2024-06-10T16:43:41Z

src/librustdoc/html/static/css/rustdoc.css

@@ -898,8 +898,8 @@ because of the `[-]` element which would overlap with it. */
 	So, for table layouts, override the default with break-word, which does
 	_not_ affect min-content intrinsic sizes.
 */
-table,
-.item-table {
+.item-table,


This change can be removed.

BradMarr · 2024-06-10T17:58:47Z

I'm confused on how to fix the check issues.

GuillaumeGomez · 2024-06-10T19:39:47Z

It says that in tests/rustdoc-gui/type-declation-overflow.goml at line 19, if expected a different value for the offsetWidth element property. Since you modified it, seems logical that it fails.

BradMarr · 2024-06-10T19:57:07Z

It says that in tests/rustdoc-gui/type-declation-overflow.goml at line 19, if expected a different value for the offsetWidth element property. Since you modified it, seems logical that it fails.

How should I go about fixing that?

GuillaumeGomez · 2024-06-10T20:33:18Z

Update the mentioned file.

BradMarr · 2024-06-10T20:34:52Z

Update the mentioned file.

The mentioned file being the test or the css page?

GuillaumeGomez · 2024-06-10T20:52:09Z

The test.

rustbot · 2024-06-10T20:57:47Z

Some changes occurred in GUI tests.

cc @GuillaumeGomez

BradMarr · 2024-06-13T23:16:58Z

What if we did something like this, where instead of a table it is a flex? It does look a little different but I don't mind the appearance.

GuillaumeGomez · 2024-06-14T20:05:36Z

The failure is "normal", not related to your changes. I restarted failing checks. If it still fails with the same error, just rebase.

The type name ID map has underscores in its names, so the query element should have them, too.

- Autolabel PRs modifying `tests/run-make/` and `src/tools/run-make-support/` with `X-run-make` label. - Add reminder to update the tracking issue <#121876> if applicable when `tests/run-make/` is modified by a PR.

Update rustdoc.css Update rustdoc.css Update rustdoc.css Update rustdoc.css Update rustdoc.css Update rustdoc.css Update type-declation-overflow.goml fix test make into flex

rustbot · 2024-06-29T01:22:53Z

Some changes occurred in src/tools/clippy

cc @rust-lang/clippy

triagebot.toml has been modified, there may have been changes to the review queue.

cc @davidtwco, @wesleywiser

The list of allowed third-party dependencies may have been modified! You must ensure that any new dependencies have compatible licenses before merging.

cc @davidtwco, @wesleywiser

These commits modify the Cargo.lock file. Unintentional changes to Cargo.lock can be introduced when switching branches and rebasing PRs.

If this was unintentional then you should revert the changes before this PR is merged.
Otherwise, you can ignore this comment.

GuillaumeGomez · 2024-06-29T09:52:25Z

You messed up the git history. ^^'

BradMarr · 2024-07-05T15:28:07Z

I think I'm a little bit out of my depth here, somebody else should probably take the reins. Thanks for your patience you guys.

If there's anything I can do to make it easier for you guys, I can do that for you.

GuillaumeGomez · 2024-07-05T15:29:17Z

I'll take a look tomorrow.

GuillaumeGomez · 2024-07-06T10:15:33Z

Closing in favor of #127418.

…name, r=notriddle Wrap too long type name Fixes rust-lang#120595. Takeover of rust-lang#126209. cc `@BradMarr` r? `@notriddle`

Rollup merge of rust-lang#127418 - GuillaumeGomez:wrap-too-long-type-name, r=notriddle Wrap too long type name Fixes rust-lang#120595. Takeover of rust-lang#126209. cc `@BradMarr` r? `@notriddle`

…-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 `BTreeMap`, not `BTreeMap`. - 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 `TyCtx` would have an HTML overhead of 50%. Line breaking inside it makes no sense. # Screenshots | Before | After | | ------ | ----- | | ![image](https://github.com/rust-lang/rust/assets/1593513/d51201fd-46c0-4f48-aee6-a477eadba288) | ![image](https://github.com/rust-lang/rust/assets/1593513/d8e77582-adcf-4966-bbfd-19dfdad7336a)

Rollup merge of rust-lang#126247 - notriddle:notriddle/word-wrap-item-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 `BTreeMap`, not `BTreeMap`. - 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 `TyCtx` would have an HTML overhead of 50%. Line breaking inside it makes no sense. # Screenshots | Before | After | | ------ | ----- | | ![image](https://github.com/rust-lang/rust/assets/1593513/d51201fd-46c0-4f48-aee6-a477eadba288) | ![image](https://github.com/rust-lang/rust/assets/1593513/d8e77582-adcf-4966-bbfd-19dfdad7336a)

Update rustdoc.css

ee6459d

rustbot assigned GuillaumeGomez Jun 9, 2024

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 9, 2024

This comment has been minimized.

Sign in to view

rustbot added has-merge-commits PR has merge commits, merge with caution. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 10, 2024

This comment has been minimized.

Sign in to view

GuillaumeGomez reviewed Jun 10, 2024

View reviewed changes

src/librustdoc/html/static/css/rustdoc.css Outdated Show resolved Hide resolved

GuillaumeGomez reviewed Jun 10, 2024

View reviewed changes

This comment has been minimized.

Sign in to view

clubby789 and others added 7 commits June 28, 2024 21:19

Update icu4x dependencies

4698e10

Update r-efi

0a0be58

Run cargo update

6e8c45d

rustdoc-search: use lowercase, non-normalized name for type search

66a62f4

The type name ID map has underscores in its names, so the query element should have them, too.

Autolabel run-make tests, remind to update tracking issue

304ac23

- Autolabel PRs modifying `tests/run-make/` and `src/tools/run-make-support/` with `X-run-make` label. - Add reminder to update the tracking issue <#121876> if applicable when `tests/run-make/` is modified by a PR.

Migrate more things to WinError

d543660

Update rustdoc.css

35479c6

Update rustdoc.css Update rustdoc.css Update rustdoc.css Update rustdoc.css Update rustdoc.css Update rustdoc.css Update type-declation-overflow.goml fix test make into flex

rustbot removed has-merge-commits PR has merge commits, merge with caution. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 29, 2024

GuillaumeGomez mentioned this pull request Jul 6, 2024

Wrap too long type name #127418

Merged

notriddle closed this Jul 6, 2024

BradMarr deleted the fix-weird-text-wrapping-for-long-type-names branch July 6, 2024 16:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update rustdoc.css #126209

Update rustdoc.css #126209

BradMarr commented Jun 9, 2024 •

edited by fmease

Loading

rustbot commented Jun 9, 2024

rustbot commented Jun 9, 2024

GuillaumeGomez commented Jun 9, 2024

BradMarr commented Jun 9, 2024 •

edited

Loading

This comment has been minimized.

BradMarr commented Jun 9, 2024

rustbot commented Jun 10, 2024

notriddle commented Jun 10, 2024

This comment has been minimized.

BradMarr commented Jun 10, 2024 •

edited

Loading

notriddle commented Jun 10, 2024

BradMarr commented Jun 10, 2024 •

edited

Loading

BradMarr commented Jun 10, 2024

This comment has been minimized.

GuillaumeGomez Jun 10, 2024

This comment has been minimized.

BradMarr commented Jun 10, 2024

GuillaumeGomez commented Jun 10, 2024

BradMarr commented Jun 10, 2024

GuillaumeGomez commented Jun 10, 2024

BradMarr commented Jun 10, 2024

GuillaumeGomez commented Jun 10, 2024

rustbot commented Jun 10, 2024

BradMarr commented Jun 13, 2024 •

edited

Loading

This comment has been minimized.

GuillaumeGomez commented Jun 14, 2024

rustbot commented Jun 29, 2024

GuillaumeGomez commented Jun 29, 2024

BradMarr commented Jul 5, 2024 •

edited

Loading

GuillaumeGomez commented Jul 5, 2024

GuillaumeGomez commented Jul 6, 2024

Update rustdoc.css #126209

Update rustdoc.css #126209

Conversation

BradMarr commented Jun 9, 2024 • edited by fmease Loading

rustbot commented Jun 9, 2024

rustbot commented Jun 9, 2024

GuillaumeGomez commented Jun 9, 2024

BradMarr commented Jun 9, 2024 • edited Loading

This comment has been minimized.

BradMarr commented Jun 9, 2024

rustbot commented Jun 10, 2024

notriddle commented Jun 10, 2024

Before

After

This comment has been minimized.

BradMarr commented Jun 10, 2024 • edited Loading

notriddle commented Jun 10, 2024

BradMarr commented Jun 10, 2024 • edited Loading

BradMarr commented Jun 10, 2024

This comment has been minimized.

GuillaumeGomez Jun 10, 2024

Choose a reason for hiding this comment

This comment has been minimized.

BradMarr commented Jun 10, 2024

GuillaumeGomez commented Jun 10, 2024

BradMarr commented Jun 10, 2024

GuillaumeGomez commented Jun 10, 2024

BradMarr commented Jun 10, 2024

GuillaumeGomez commented Jun 10, 2024

rustbot commented Jun 10, 2024

BradMarr commented Jun 13, 2024 • edited Loading

This comment has been minimized.

GuillaumeGomez commented Jun 14, 2024

rustbot commented Jun 29, 2024

GuillaumeGomez commented Jun 29, 2024

BradMarr commented Jul 5, 2024 • edited Loading

GuillaumeGomez commented Jul 5, 2024

GuillaumeGomez commented Jul 6, 2024

BradMarr commented Jun 9, 2024 •

edited by fmease

Loading

BradMarr commented Jun 9, 2024 •

edited

Loading

BradMarr commented Jun 10, 2024 •

edited

Loading

BradMarr commented Jun 10, 2024 •

edited

Loading

BradMarr commented Jun 13, 2024 •

edited

Loading

BradMarr commented Jul 5, 2024 •

edited

Loading