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

Make # pretty print format easier to discover #83388

Merged
merged 2 commits into from
Mar 27, 2021

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Mar 22, 2021

Rationale:

I use (cargo cult?) three formats in rust: {}, debug {:?}, and pretty-print debug {:#?}. I discovered {:#?} in some blog post or guide when I started working in Rust. While # is documented I think it is hard to discover. So taking the good advice of @carols10cents I am trying to improve the docs with a PR

As a reminder "pretty print" means that where {:?} will print something like

foo: { b1: 1, b2: 2}

{:#?} will prints something like

foo {
  b1: 1
  b2: 3
}

Changes

Add an example to fmt to try and make it easier to discover #

@rust-highfive
Copy link
Collaborator

r? @Mark-Simulacrum

(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 Mar 22, 2021
library/alloc/src/fmt.rs Outdated Show resolved Hide resolved
@alamb alamb changed the title Make # format easier to discover Make # pretty print format easier to discover Mar 23, 2021
@Mark-Simulacrum
Copy link
Member

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Mar 26, 2021

📌 Commit 93737dc has been approved by Mark-Simulacrum

@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 Mar 26, 2021
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Mar 26, 2021
Make # pretty print format easier to discover

# Rationale:

I use (cargo cult?) three formats in rust:  `{}`, debug `{:?}`, and pretty-print debug `{:#?}`. I discovered `{:#?}` in some blog post or guide when I started working in Rust. While `#` is documented I think it is hard to discover. So taking the good advice of `@carols10cents`  I am trying to improve the docs with a PR

As a reminder "pretty print" means that where `{:?}` will print something like
```
foo: { b1: 1, b2: 2}
```

`{:#?}` will prints something like
```
foo {
  b1: 1
  b2: 3
}
```

# Changes
Add an example to `fmt` to try and make it easier to discover `#`
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Mar 27, 2021
Make # pretty print format easier to discover

# Rationale:

I use (cargo cult?) three formats in rust:  `{}`, debug `{:?}`, and pretty-print debug `{:#?}`. I discovered `{:#?}` in some blog post or guide when I started working in Rust. While `#` is documented I think it is hard to discover. So taking the good advice of ``@carols10cents``  I am trying to improve the docs with a PR

As a reminder "pretty print" means that where `{:?}` will print something like
```
foo: { b1: 1, b2: 2}
```

`{:#?}` will prints something like
```
foo {
  b1: 1
  b2: 3
}
```

# Changes
Add an example to `fmt` to try and make it easier to discover `#`
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 27, 2021
Rollup of 9 pull requests

Successful merges:

 - rust-lang#83239 (Remove/replace some outdated crates from the dependency tree)
 - rust-lang#83328 (Fixes to inline assmebly tests)
 - rust-lang#83343 (Simplify and fix byte skipping in format! string parser)
 - rust-lang#83388 (Make # pretty print format easier to discover)
 - rust-lang#83431 (Tell GitHub to highlight `config.toml.example` as TOML)
 - rust-lang#83508 (Use the direct link to the platform support page)
 - rust-lang#83511 (compiletest: handle llvm_version with suffix like "12.0.0libcxx")
 - rust-lang#83524 (Document that the SocketAddr memory representation is not stable)
 - rust-lang#83525 (fix doc comment for `ty::Dynamic`)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit c143267 into rust-lang:master Mar 27, 2021
@rustbot rustbot added this to the 1.53.0 milestone Mar 27, 2021
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