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

Remove doubled braces in non_exhaustive structs’ documentation text. #85657

Merged
merged 1 commit into from
May 25, 2021

Conversation

kpreid
Copy link
Contributor

@kpreid kpreid commented May 25, 2021

In commit 4b80687 (part of Rust 1.52.1) many calls to write!(w, were replaced with w.write_str(, but this one contained braces that were doubled to escape them when taken as a format string, and so changing the call without changing the text caused them to become doubled in the final HTML output.

I examined print_item.rs and the diff of that prior commit for any other occurrences of this mistake and I did not find any.

In commit 4b80687 (part of Rust 1.52.1)
many calls to `write!(w,` were replaced with `w.write_str(`, but this
one contained braces that were doubled to escape them when taken as a
format string, and so changing the call without changing the text caused
them to become doubled in the final HTML output.

I examined `print_item.rs` and the diff of that prior commit for any
other occurrences of this mistake and I did not find any.
@rust-highfive
Copy link
Collaborator

r? @GuillaumeGomez

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 25, 2021
@jyn514
Copy link
Member

jyn514 commented May 25, 2021

Long term I think we should stop duplicating this altogether and link to the reference instead: #84309 (comment). But this is a good fix in the meantime.

r=me with CI passing

@jyn514
Copy link
Member

jyn514 commented May 25, 2021

@bors r+ rollup

@bors
Copy link
Contributor

bors commented May 25, 2021

📌 Commit 08e7c6b has been approved by jyn514

@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 May 25, 2021
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request May 25, 2021
Remove doubled braces in non_exhaustive structs’ documentation text.

In commit 4b80687 (part of Rust 1.52.1) many calls to `write!(w,` were replaced with `w.write_str(`, but this one contained braces that were doubled to escape them when taken as a format string, and so changing the call without changing the text caused them to become doubled in the final HTML output.

I examined `print_item.rs` and the diff of that prior commit for any other occurrences of this mistake and I did not find any.
This was referenced May 25, 2021
bors added a commit to rust-lang-ci/rust that referenced this pull request May 25, 2021
…laumeGomez

Rollup of 6 pull requests

Successful merges:

 - rust-lang#85361 (Use TargetTriple::from_path in rustdoc)
 - rust-lang#85605 (Replace Local::new(1) with CAPTURE_STRUCT_LOCAL)
 - rust-lang#85631 (Move keyword primitive css dom)
 - rust-lang#85644 (Better English for documenting when to use unimplemented!())
 - rust-lang#85650 (Add some backticks to the `rustc_middle::ty::adjustment::Adjustment` docs)
 - rust-lang#85657 (Remove doubled braces in non_exhaustive structs’ documentation text.)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit afec726 into rust-lang:master May 25, 2021
@rustbot rustbot added this to the 1.54.0 milestone May 25, 2021
@kpreid kpreid deleted the brackets branch June 17, 2021 00:30
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants