Skip to content

rustdoc: do not escape quotes in body text #118508

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Dec 5, 2023
Merged

rustdoc: do not escape quotes in body text #118508

merged 1 commit into from
Dec 5, 2023

Conversation

notriddle
Copy link
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
Member

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

@bors try

@GuillaumeGomez
Copy link
Member

@bors try @rust-timer queue

@rust-timer

This comment has been minimized.

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

bors commented Dec 1, 2023

⌛ Trying commit b662dcf with merge e2ba874...

bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 1, 2023
@bors
Auto merge of rust-lang#118508 - notriddle:notriddle/fmt-newline, r=<…
e2ba874 
…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.

Sign in to view
@bors
Copy link
Collaborator

bors commented Dec 1, 2023

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

@rust-timer

This comment has been minimized.

Sign in to view
@rust-timer
Copy link
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
@notriddle
rustdoc: do not escape quotes in body text
6da2b7d 
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 force-pushed the notriddle/fmt-newline branch from b662dcf to 6da2b7d Compare December 1, 2023 22:15
@GuillaumeGomez
Copy link
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
Copy link
Collaborator

bors commented Dec 4, 2023

📌 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
Rollup merge of rust-lang#118508 - notriddle:notriddle/fmt-newline, r…
591d15a 
…=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/
```
@GuillaumeGomez GuillaumeGomez mentioned this pull request Dec 4, 2023
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 4, 2023
@bors
Auto merge of rust-lang#118617 - GuillaumeGomez:rollup-9zj8ylu, r=Gui…
280ec21 
…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
@GuillaumeGomez GuillaumeGomez mentioned this pull request Dec 4, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 4, 2023
@bors
Auto merge of rust-lang#118618 - GuillaumeGomez:rollup-24ur21r, r=Gui…
da1da3f 
…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
@rust-timer
Unrolled build for rust-lang#118508
794d464 
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
Reviewers

@GuillaumeGomez GuillaumeGomez GuillaumeGomez approved these changes

Assignees

@GuillaumeGomez GuillaumeGomez

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
Milestone
1.76.0
Development

Successfully merging this pull request may close these issues.
6 participants
@notriddle @GuillaumeGomez @rust-timer @bors @rust-log-analyzer @rustbot