Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rustdoc: stop preloading Source Serif 4 Bold #115904

Merged
merged 1 commit into from
Nov 7, 2023

Conversation

notriddle
Copy link
Contributor

@notriddle notriddle commented Sep 17, 2023

According to #91170, italic fonts are not preloaded because they're rarely used, but bold fonts are. This seems to be true of bold Source Code Pro and bold Fira Sans, but bold and italic Source Serif Pro seem to be equally heavily used.

This is, I assume, the result of using Fira Sans Bold and Source Code Bold headings, so you only get bold Serif text when the doc author uses strong ** emphasis (or within certain kinds of tooltip, which shouldn't be preloaded because they only show up long after the page is loaded).

To check this, run these two commands in the browser console to measure how much they're used. The measurement is extremely rough, but it gets the idea across: the two styles are about equally popular.

// count bold elements
Array.prototype.slice.call(document.querySelectorAll("*")).filter(x => { const y = document.defaultView.getComputedStyle(x); return y.fontFamily.indexOf("Source Serif 4") !== -1 && y.fontWeight > 400 }).length
// count italic elements
Array.prototype.slice.call(document.querySelectorAll("*")).filter(x => { const y = document.defaultView.getComputedStyle(x); return y.fontFamily.indexOf("Source Serif 4") !== -1 && y.fontStyle == "italic" }).length
URL Bold Italic
std 2 9
Vec 8 89
regex 33 17
test_suite 0 0

According to 4198fac, italic fonts are
not preloaded because they're rarely used, but bold fonts are. This
seems to be true of bold Source Code Pro and bold Fira Sans, but
bold and italic Source Serif Pro seem to be equally heavily used.

This is, I assume, the result of using Fira Sans Bold and Source Code
Bold headings, so you only get bold Serif text when the doc author
uses strong `**` emphasis (or within certain kinds of tooltip,
which shouldn't be preloaded because they only show up long after
the page is loaded).

To check this, run these two commands in the browser console to
measure how much they're used. The measurement is extremely rough,
but it gets the idea across: the two styles are about equally popular.

    // count bold elements
    Array.prototype.slice.call(document.querySelectorAll("*")).filter(x => { const y = document.defaultView.getComputedStyle(x); return y.fontFamily.indexOf("Source Serif 4") !== -1 && y.fontWeight > 400 }).length
    // count italic elements
    Array.prototype.slice.call(document.querySelectorAll("*")).filter(x => { const y = document.defaultView.getComputedStyle(x); return y.fontFamily.indexOf("Source Serif 4") !== -1 && y.fontStyle == "italic" }).length

| URL     | Bold | Italic |
|---------|-----:|-------:|
| [std]   |    2 |      9 |
| [Vec]   |    8 |     89 |
| [regex] |   33 |     17 |

[std]: https://doc.rust-lang.org/nightly/std/index.html
[Vec]: https://doc.rust-lang.org/nightly/std/vec/struct.Vec.html
[regex]: https://docs.rs/regex/1.9.5/regex/index.html
@rustbot
Copy link
Collaborator

rustbot commented Sep 17, 2023

r? @jsha

(rustbot has picked a reviewer for you, use r? to override)

@rustbot 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 Sep 17, 2023
@aDotInTheVoid aDotInTheVoid added the A-rustdoc-ui Area: Rustdoc UI (generated HTML) label Sep 30, 2023
@GuillaumeGomez
Copy link
Member

Please re-assign to someone else @notriddle if the reviewer is not available. 😉

Thanks for this!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Nov 7, 2023

📌 Commit 2a92981 has been approved by GuillaumeGomez

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 7, 2023
@bors
Copy link
Contributor

bors commented Nov 7, 2023

⌛ Testing commit 2a92981 with merge 9bd71af...

@bors
Copy link
Contributor

bors commented Nov 7, 2023

☀️ Test successful - checks-actions
Approved by: GuillaumeGomez
Pushing 9bd71af to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Nov 7, 2023
@bors bors merged commit 9bd71af into rust-lang:master Nov 7, 2023
12 checks passed
@rustbot rustbot added this to the 1.75.0 milestone Nov 7, 2023
@notriddle notriddle deleted the notriddle/preload-bold branch November 7, 2023 17:44
@rust-timer
Copy link
Collaborator

Finished benchmarking commit (9bd71af): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

mean range count
Regressions ❌
(primary)
0.5% [0.5%, 0.5%] 1
Regressions ❌
(secondary)
0.9% [0.9%, 0.9%] 1
Improvements ✅
(primary)
- - 0
Improvements ✅
(secondary)
- - 0
All ❌✅ (primary) 0.5% [0.5%, 0.5%] 1

Cycles

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

mean range count
Regressions ❌
(primary)
- - 0
Regressions ❌
(secondary)
2.4% [2.3%, 2.5%] 2
Improvements ✅
(primary)
- - 0
Improvements ✅
(secondary)
-0.6% [-0.6%, -0.6%] 1
All ❌✅ (primary) - - 0

Binary size

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

mean range count
Regressions ❌
(primary)
- - 0
Regressions ❌
(secondary)
- - 0
Improvements ✅
(primary)
-0.0% [-0.0%, -0.0%] 3
Improvements ✅
(secondary)
-0.0% [-0.0%, -0.0%] 1
All ❌✅ (primary) -0.0% [-0.0%, -0.0%] 3

Bootstrap: 663.805s -> 663.998s (0.03%)
Artifact size: 308.97 MiB -> 308.95 MiB (-0.01%)

celinval added a commit to celinval/rust-dev that referenced this pull request Jun 4, 2024
Update Rust toolchain from nightly-2023-11-07 to nightly-2023-11-08
without any other source changes.
This is an automatically generated pull request. If any of the CI checks
fail, manual intervention is required. In such a case, review the
changes at https://github.com/rust-lang/rust from
rust-lang@189d6c7
up to
rust-lang@7adc89b.
The log for this commit range is:
rust-lang@7adc89b69b Auto merge of
rust-lang#117680 - matthiaskrgr:rollup-kgaa4ma, r=matthiaskrgr
rust-lang@518fe492f1 Rollup merge of
rust-lang#117675 - zmodem:vectorize_h, r=durin42
rust-lang@f6f6fd1d1a Rollup merge of
rust-lang#117639 - rustbot:docs-update, r=ehuss
rust-lang@f8c67704f2 Rollup merge of
rust-lang#117616 - RalfJung:unstable-target-features, r=compiler-errors
rust-lang@cd5b5e08fe Rollup merge of
rust-lang#115485 - DaniPopes:rustdoc-macro-consts, r=jackh726,fmease
rust-lang@118a2deea5 Auto merge of
rust-lang#117617 - Urgau:bump-libc-0.2.150, r=Mark-Simulacrum
rust-lang@84abf837b8 manually bless a
wasm-only test
rust-lang@752a6132e5 llvm-wrapper: Remove
include of non-existant Vectorize.h
rust-lang@9bd71afb90 Auto merge of
rust-lang#115904 - notriddle:notriddle/preload-bold, r=GuillaumeGomez
rust-lang@187d1afa9d Auto merge of
rust-lang#117297 - clubby789:fn-trait-missing-paren, r=TaKO8Ki
rust-lang@61a3eea804 Auto merge of
rust-lang#117229 - matthewjasper:thir-unsafeck-fixes, r=cjgillot
rust-lang@114f1f6838 Auto merge of
rust-lang#117610 - compiler-errors:object-hmm, r=aliemjay
rust-lang@504f63efb0 Auto merge of
rust-lang#117418 - compiler-errors:better_error_body, r=oli-obk
rust-lang@4e0fb98a5c Auto merge of
rust-lang#117006 - estebank:issue-69512, r=compiler-errors
rust-lang@f926031ea5 When not finding
assoc fn on type, look for builder fn
rust-lang@7b97a5ca84 Auto merge of
rust-lang#117511 - gurry:117406-err-packed-structs, r=compiler-errors
rust-lang@5a9f07cc97 Build a better MIR
body when errors are encountered
rust-lang@171d5587ca Don't instantiate
the binder twice when assembling object candidate
rust-lang@24e14dd8b4 Only check
predicates for late-bound non-lifetime vars in object candidate assembly
rust-lang@bf65e3bddb Update books
rust-lang@868de8e76b Visit patterns in
THIR let expressions
rust-lang@2b59992736 Add suggestion to
THIR unsafe_op_in_unsafe_fn lint
rust-lang@2b2c0f9886 Allow tests with
rust-rustfix and revisions
rust-lang@931692fa13 Recognise thread
local statics in THIR unsafeck
rust-lang@b85c6835d0 warn when using an
unstable feature with -Ctarget-feature
rust-lang@15719a8c1d libc: bump
dependency to 0.2.150
rust-lang@4b3ece475d Emit explanatory
note for move errors in packed struct derives
rust-lang@904aceec7d Give a better
diagnostic for missing parens in Fn* bounds
rust-lang@2b858b7eb8 Format macro const
literals with pretty printer
rust-lang@2a92981301 rustdoc: stop
preloading Source Serif 4 Bold

Co-authored-by: celinval <[email protected]>
Co-authored-by: Zyad Hassan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants