Skip to content

rustdoc: do not escape quotes in body text#118508

Merged
bors merged 1 commit into
rust-lang:masterfrom
notriddle:notriddle/fmt-newline
Dec 5, 2023
Merged

rustdoc: do not escape quotes in body text#118508
bors merged 1 commit into
rust-lang:masterfrom
notriddle:notriddle/fmt-newline

Conversation

@notriddle

Copy link
Copy Markdown
Contributor

Escaping quote marks is only needed in attributes, not text.

$ du -hs doc-old/ doc-new/
670M    doc-old/
669M    doc-new/

@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 Dec 1, 2023
@GuillaumeGomez

Copy link
Copy Markdown
Member

Interesting. Let's see if there is an impact on perf too.

@bors try

@GuillaumeGomez

Copy link
Copy Markdown
Member

@bors try @rust-timer queue

@rust-timer

This comment has been minimized.

@rustbot rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Dec 1, 2023
@bors

bors commented Dec 1, 2023

Copy link
Copy Markdown
Collaborator

⌛ Trying commit b662dcf with merge e2ba874...

bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 1, 2023
…try>

rustdoc: do not escape quotes in body text

Escaping quote marks is only needed in attributes, not text.

```console
$ du -hs doc-old/ doc-new/
670M    doc-old/
669M    doc-new/
```
@rust-log-analyzer

This comment has been minimized.

@bors

bors commented Dec 1, 2023

Copy link
Copy Markdown
Collaborator

☀️ Try build successful - checks-actions
Build commit: e2ba874 (e2ba8745008c286f8690ae723658bf668caf0899)

@rust-timer

This comment has been minimized.

@rust-timer

Copy link
Copy Markdown
Collaborator

Finished benchmarking commit (e2ba874): comparison URL.

Overall result: ✅ improvements - no action needed

Benchmarking this pull request likely means that it is perf-sensitive, so we're automatically marking it as not fit for rolling up. While you can manually mark this PR as fit for rollup, we strongly recommend not doing so since this PR may lead to changes in compiler perf.

@bors rollup=never
@rustbot label: -S-waiting-on-perf -perf-regression

Instruction count

This is a highly reliable metric that was used to determine the overall result at the top of this comment.

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

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)
2.6% [2.6%, 2.6%] 2
Regressions ❌
(secondary)
1.9% [1.9%, 1.9%] 1
Improvements ✅
(primary)
- - 0
Improvements ✅
(secondary)
-2.7% [-2.7%, -2.7%] 1
All ❌✅ (primary) 2.6% [2.6%, 2.6%] 2

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)
- - 0
Improvements ✅
(primary)
- - 0
Improvements ✅
(secondary)
-1.7% [-1.7%, -1.7%] 1
All ❌✅ (primary) - - 0

Binary size

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

Bootstrap: 672.427s -> 672.738s (0.05%)
Artifact size: 313.37 MiB -> 313.42 MiB (0.01%)

@rustbot rustbot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Dec 1, 2023
Escaping quote marks is only needed in attributes, not text.

```console
$ du -hs doc-old/ doc-new/
670M    doc-old/
669M    doc-new/
```
@GuillaumeGomez

Copy link
Copy Markdown
Member

Documentation size reduction is pretty nice in the perf check and the small instruction count reduction (if not noise) is pretty nice too. Great work!

@bors r+ rollup

@bors

bors commented Dec 4, 2023

Copy link
Copy Markdown
Collaborator

📌 Commit 6da2b7d 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 Dec 4, 2023
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Dec 4, 2023
…=GuillaumeGomez

rustdoc: do not escape quotes in body text

Escaping quote marks is only needed in attributes, not text.

```console
$ du -hs doc-old/ doc-new/
670M    doc-old/
669M    doc-new/
```
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 4, 2023
…llaumeGomez

Rollup of 5 pull requests

Successful merges:

 - rust-lang#118076 (Tweak `.clone()` suggestion to work in more cases)
 - rust-lang#118508 (rustdoc: do not escape quotes in body text)
 - rust-lang#118565 (interpret: make numeric_intrinsic accessible from Miri)
 - rust-lang#118591 (portable-simd: fix test suite build)
 - rust-lang#118600 ([rustdoc] Don't generate the "Fields" heading if there is no field displayed)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 4, 2023
…llaumeGomez

Rollup of 4 pull requests

Successful merges:

 - rust-lang#118508 (rustdoc: do not escape quotes in body text)
 - rust-lang#118565 (interpret: make numeric_intrinsic accessible from Miri)
 - rust-lang#118591 (portable-simd: fix test suite build)
 - rust-lang#118600 ([rustdoc] Don't generate the "Fields" heading if there is no field displayed)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit 963e8e8 into rust-lang:master Dec 5, 2023
@rustbot rustbot added this to the 1.76.0 milestone Dec 5, 2023
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Dec 5, 2023
Rollup merge of rust-lang#118508 - notriddle:notriddle/fmt-newline, r=GuillaumeGomez

rustdoc: do not escape quotes in body text

Escaping quote marks is only needed in attributes, not text.

```console
$ du -hs doc-old/ doc-new/
670M    doc-old/
669M    doc-new/
```
@notriddle
notriddle deleted the notriddle/fmt-newline branch December 5, 2023 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

6 participants