Fix docs for formatting delegations #67021
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
r? @Kimundi (rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
QuietMisdreavus
approved these changes
Dec 4, 2019
There was a problem hiding this comment.
Nice catch!
As for your comment about looping, i'm not sure the best way to handle it. Since you can't copy out a Formatter's arguments to a new struct, or modify them once they've been created, there's no good way to clear the alternate flag while keeping everything else. You probably have to reimplement the integer formatter to the way you want, since you probably want to handle things like padding and alignment as a whole instead of per-element. For now, though, this is a good change to the docs. Thanks so much!
|
@bors r+ |
|
📌 Commit 8be7223 has been approved by |
bors
added
S-waiting-on-bors
|
@bors rollup (forgot to roll it up, this is unlikely to conflict with anything) |
JohnTitor
added a commit
to JohnTitor/rust
that referenced
this pull request
Dec 5, 2019
Fix docs for formatting delegations If you use the example in the docs right now it breaks all the options Formatters have to offer. i.e. https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=214392ecc6eff73b4789c32568395f72 this should've padded the output with 4 zeros but didn't. with the new example it does work: https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=3bdfb29f395230c5129c5f56dcfcb2a9 The only thing i'm not quite sure about is what's the right way to do it in a loop (altough non of the docs talk about it people are doing it in the wild and there were a couple of attempts to include in libcore) i.e. https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=4c4dca3c90ba36779ecd014f3899ab9c
JohnTitor
added a commit
to JohnTitor/rust
that referenced
this pull request
Dec 5, 2019
Fix docs for formatting delegations If you use the example in the docs right now it breaks all the options Formatters have to offer. i.e. https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=214392ecc6eff73b4789c32568395f72 this should've padded the output with 4 zeros but didn't. with the new example it does work: https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=3bdfb29f395230c5129c5f56dcfcb2a9 The only thing i'm not quite sure about is what's the right way to do it in a loop (altough non of the docs talk about it people are doing it in the wild and there were a couple of attempts to include in libcore) i.e. https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=4c4dca3c90ba36779ecd014f3899ab9c
RalfJung
added a commit
to RalfJung/rust
that referenced
this pull request
Dec 5, 2019
Fix docs for formatting delegations If you use the example in the docs right now it breaks all the options Formatters have to offer. i.e. https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=214392ecc6eff73b4789c32568395f72 this should've padded the output with 4 zeros but didn't. with the new example it does work: https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=3bdfb29f395230c5129c5f56dcfcb2a9 The only thing i'm not quite sure about is what's the right way to do it in a loop (altough non of the docs talk about it people are doing it in the wild and there were a couple of attempts to include in libcore) i.e. https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=4c4dca3c90ba36779ecd014f3899ab9c
bors
added a commit
that referenced
this pull request
Dec 5, 2019
Rollup of 13 pull requests Successful merges: - #66405 (Tweak `ObligationForest` `NodeState`s) - #66730 (remove dependency from libhermit) - #66764 (Tweak wording of `collect()` on bad target type) - #66899 (Standard library support for riscv64gc-unknown-linux-gnu) - #66900 (Clean up error codes) - #66974 ([CI] fix the `! isCI` check in src/ci/run.sh) - #66979 (Add long error for E0631 and update ui tests.) - #67005 (capitalize Rust) - #67010 (Accurately portray raw identifiers in error messages) - #67011 (Include a span in more `expected...found` notes) - #67017 (cleanup long error explanations) - #67021 (Fix docs for formatting delegations) - #67041 (add ExitStatusExt into prelude) Failed merges: r? @ghost
|
Bonus points if you make a follow-up PR that actually asserts (in the doctest) that padding is handled properly. ;) |
Will do when this is merged (so there won't be a conflict) :) |
JohnTitor
added a commit
to JohnTitor/rust
that referenced
this pull request
Dec 6, 2019
Fix docs for formatting delegations If you use the example in the docs right now it breaks all the options Formatters have to offer. i.e. https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=214392ecc6eff73b4789c32568395f72 this should've padded the output with 4 zeros but didn't. with the new example it does work: https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=3bdfb29f395230c5129c5f56dcfcb2a9 The only thing i'm not quite sure about is what's the right way to do it in a loop (altough non of the docs talk about it people are doing it in the wild and there were a couple of attempts to include in libcore) i.e. https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=4c4dca3c90ba36779ecd014f3899ab9c
bors
added a commit
that referenced
this pull request
Dec 6, 2019
Rollup of 10 pull requests Successful merges: - #66649 (VxWorks: fix issues in accessing environment variables) - #66764 (Tweak wording of `collect()` on bad target type) - #66900 (Clean up error codes) - #66974 ([CI] fix the `! isCI` check in src/ci/run.sh) - #66979 (Add long error for E0631 and update ui tests.) - #67017 (cleanup long error explanations) - #67021 (Fix docs for formatting delegations) - #67041 (add ExitStatusExt into prelude) - #67065 (Fix fetching arguments on the wasm32-wasi target) - #67066 (Update the revision of wasi-libc used in wasm32-wasi) Failed merges: r? @ghost
|
☔ The latest upstream changes (presumably #67080) made this pull request unmergeable. Please resolve the merge conflicts. |
bors
added
S-waiting-on-author
Mark-Simulacrum
added a commit
to Mark-Simulacrum/rust
that referenced
this pull request
Dec 19, 2019
Add more delegations to the fmt docs and add doctests HI, this is a continuation to rust-lang#67021 I replaced the `Debug` example with one that use the `Debug*` helpers so that padding etc will work too. I also added asserts for the doctests as @RalfJung asked :) The only thing I left with the `write!` macro is the `Display` example as I didn't know if there's a better way to do that. r? @QuietMisdreavus
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If you use the example in the docs right now it breaks all the options Formatters have to offer.
i.e. https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=214392ecc6eff73b4789c32568395f72 this should've padded the output with 4 zeros but didn't.
with the new example it does work: https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=3bdfb29f395230c5129c5f56dcfcb2a9
The only thing i'm not quite sure about is what's the right way to do it in a loop (altough non of the docs talk about it people are doing it in the wild and there were a couple of attempts to include in libcore)
i.e. https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=4c4dca3c90ba36779ecd014f3899ab9c