Doc improvement on std::fmt module #33129

GuillaumeGomez · 2016-04-21T12:56:55Z

Part of #29355.

steveklabnik · 2016-04-26T13:56:54Z

failures:

---- fmt::write_0 stdout ----
    <anon>:7:5: 7:65 error: unused result which must be used
<anon>:7     fmt::write(&mut output, format_args!("Hello {}!", "world"));
             ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
<anon>:1:9: 1:17 note: lint level defined here
<anon>:1 #![deny(warnings)]
                 ^~~~~~~~
error: aborting due to previous error(s)
thread 'fmt::write_0' panicked at 'Box<Any>', src/librustc/session/mod.rs:164
note: Run with `RUST_BACKTRACE=1` for a backtrace.

---- fmt::write_1 stdout ----
    <std macros>:2:1: 2:54 error: unused result which must be used
<std macros>:2 $ dst . write_fmt ( format_args ! ( $ ( $ arg ) * ) ) )
               ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
<std macros>:2:1: 2:54 note: in this expansion of write! (defined in <std macros>)
<anon>:1:9: 1:17 note: lint level defined here
<anon>:1 #![deny(warnings)]
                 ^~~~~~~~
error: aborting due to previous error(s)
thread 'fmt::write_1' panicked at 'Box<Any>', src/librustc/session/mod.rs:164


failures:
    fmt::write_0
    fmt::write_1

GuillaumeGomez · 2016-04-26T14:30:44Z

Updated.

steveklabnik · 2016-04-26T15:27:36Z

src/libcore/fmt/mod.rs

+/// use std::fmt;
+///
+/// let mut output = String::new();
+/// fmt::write(&mut output, format_args!("Hello {}!", "world")).unwrap();


Could this maybe use try! instead? It will require wrapping it in a function, like most of the IO docs do.

I didn't want to do it because of this. I think that adding a function (and more code) will lose the point I'm trying to demonstrate.

Yes, but unwrap() is not the idiomatic way to handle errors, and we don't want to show unidiomatic code.

Then I'll go with a full match pattern.

GuillaumeGomez · 2016-04-27T09:29:42Z

Updated (I went for expect method finally).

steveklabnik · 2016-04-29T17:38:15Z

I am still not sure that i prefer expect here, but we also have no official standards, so seems fine.

@bors: r+ rollup

bors · 2016-04-29T17:38:16Z

📌 Commit 93532fb has been approved by steveklabnik

bors · 2016-04-29T19:09:37Z

⌛ Testing commit 93532fb with merge 2f3d5c4...

bors · 2016-04-29T19:59:38Z

💔 Test failed - auto-linux-64-opt-rustbuild

GuillaumeGomez · 2016-04-29T23:08:22Z

Updated.

steveklabnik · 2016-04-30T14:10:25Z

@GuillaumeGomez did you push? I'm not seeing a new commit.

GuillaumeGomez · 2016-04-30T14:11:32Z

I squashed it. I fixed the failed test.

steveklabnik · 2016-05-02T15:32:39Z

Weird, github's UI is being very strange.

@bors: r+ rollup

bors · 2016-05-02T15:32:40Z

📌 Commit 0690720 has been approved by steveklabnik

@steveklabnik

Doc improvement on std::fmt module Part of rust-lang#29355. r? @steveklabnik

Manishearth · 2016-05-02T20:53:00Z

@bors r-

please don't commit libc changes. Don't use git add -a

@steveklabnik

Doc improvement on std::fmt module Part of rust-lang#29355. r? @steveklabnik

Rollup of 9 pull requests - Successful merges: #32900, #33129, #33365, #33383, #33474, #33478, #33480, #33484, #33493 - Failed merges: #33360

@steveklabnik

Doc improvement on std::fmt module Part of rust-lang#29355. r? @steveklabnik

@steveklabnik

Doc improvement on std::fmt module Part of rust-lang#29355. r? @steveklabnik

Rollup of 10 pull requests - Successful merges: #33129, #33224, #33370, #33383, #33431, #33474, #33480, #33496, #33509, #33514 - Failed merges:

Manishearth · 2016-05-09T21:59:22Z

Documenting stage2 error index (x86_64-unknown-linux-gnu)
Linkcheck stage2 (x86_64-unknown-linux-gnu)
collections/fmt/fn.write.html:79: broken link - collections/macro.write!.html
thread '<main>' panicked at 'found some broken links', /buildslave/rust-buildbot/slave/auto-linux-64-opt-rustbuild/build/src/tools/linkchecker/main.rs:54
note: Run with `RUST_BACKTRACE=1` for a backtrace.

GuillaumeGomez · 2016-05-09T22:12:15Z

I checked the urls by hand. It's getting strange...

Rollup of 10 pull requests - Successful merges: #33129, #33224, #33370, #33383, #33431, #33474, #33480, #33496, #33509, #33514 - Failed merges:

GuillaumeGomez · 2016-05-10T08:23:57Z

@Manishearth: I just re-checked: both urls are correct.

Manishearth · 2016-05-10T13:48:08Z

But does the linkcheck make step pass?

mitaa · 2016-05-10T16:17:15Z

Note that the collections::fmt::write page fails but not std::fmt::write.

This is the case since write! is not in collections.

GuillaumeGomez · 2016-05-10T17:01:12Z

@mitaa: Any clue about the guilty url?

mitaa · 2016-05-10T17:16:11Z

Maybe you could always link to the write! of std or core?
/// [write_macro]: ../../std/macro.write!.html

GuillaumeGomez · 2016-05-10T17:19:48Z

I'll try it. Thanks!

@steveklabnik

Doc improvement on std::fmt module Part of rust-lang#29355. r? @steveklabnik

steveklabnik · 2016-05-10T21:36:48Z

@bors: r-

GuillaumeGomez · 2016-05-10T21:57:23Z

And updated again.

steveklabnik · 2016-05-11T13:26:55Z

@bors: r+ rollup

bors · 2016-05-11T13:26:56Z

📌 Commit 0908d66 has been approved by steveklabnik

@steveklabnik

Doc improvement on std::fmt module Part of rust-lang#29355. r? @steveklabnik

Rollup of 9 pull requests - Successful merges: #33129, #33260, #33345, #33386, #33522, #33524, #33528, #33539, #33542 - Failed merges: #33342, #33475, #33517

rust-highfive assigned steveklabnik Apr 21, 2016

GuillaumeGomez force-pushed the fmt_doc branch from abfc10f to 138a335 Compare April 26, 2016 14:30

steveklabnik reviewed Apr 26, 2016
View reviewed changes

GuillaumeGomez force-pushed the fmt_doc branch 2 times, most recently from 08e19da to 93532fb Compare April 26, 2016 22:51

GuillaumeGomez force-pushed the fmt_doc branch from 93532fb to 0690720 Compare April 29, 2016 23:06

steveklabnik added a commit to steveklabnik/rust that referenced this pull request May 2, 2016

Rollup merge of rust-lang#33129 - GuillaumeGomez:fmt_doc, r=steveklabnik

0da788a

Doc improvement on std::fmt module Part of rust-lang#29355. r? @steveklabnik

steveklabnik mentioned this pull request May 2, 2016

Rollup of 7 pull requests #33349

Closed

Manishearth mentioned this pull request May 2, 2016

Rollup of 14 pull requests #33354

Merged

Manishearth added a commit to Manishearth/rust that referenced this pull request May 8, 2016

Rollup merge of rust-lang#33129 - GuillaumeGomez:fmt_doc, r=steveklabnik

55fcf28

Doc improvement on std::fmt module Part of rust-lang#29355. r? @steveklabnik

bors added a commit that referenced this pull request May 8, 2016

Auto merge of #33501 - Manishearth:rollup, r=Manishearth

6d369a8

Rollup of 9 pull requests - Successful merges: #32900, #33129, #33365, #33383, #33474, #33478, #33480, #33484, #33493 - Failed merges: #33360

Manishearth added a commit to Manishearth/rust that referenced this pull request May 9, 2016

Rollup merge of rust-lang#33129 - GuillaumeGomez:fmt_doc, r=steveklabnik

dd20d66

Doc improvement on std::fmt module Part of rust-lang#29355. r? @steveklabnik

Manishearth added a commit to Manishearth/rust that referenced this pull request May 9, 2016

Rollup merge of rust-lang#33129 - GuillaumeGomez:fmt_doc, r=steveklabnik

0fed5a8

Doc improvement on std::fmt module Part of rust-lang#29355. r? @steveklabnik

Manishearth mentioned this pull request May 9, 2016

Rollup of 10 pull requests #33523

Merged

bors added a commit that referenced this pull request May 9, 2016

Auto merge of #33523 - Manishearth:rollup, r=Manishearth

9d68267

Rollup of 10 pull requests - Successful merges: #33129, #33224, #33370, #33383, #33431, #33474, #33480, #33496, #33509, #33514 - Failed merges:

bors added a commit that referenced this pull request May 9, 2016

Auto merge of #33523 - Manishearth:rollup, r=Manishearth

e0fd34b

Rollup of 10 pull requests - Successful merges: #33129, #33224, #33370, #33383, #33431, #33474, #33480, #33496, #33509, #33514 - Failed merges:

steveklabnik added a commit to steveklabnik/rust that referenced this pull request May 10, 2016

Rollup merge of rust-lang#33129 - GuillaumeGomez:fmt_doc, r=steveklabnik

b6b3b7b

Doc improvement on std::fmt module Part of rust-lang#29355. r? @steveklabnik

steveklabnik mentioned this pull request May 10, 2016

Rollup of 9 pull requests #33548

Closed

Doc improvement on std::fmt module

0908d66

GuillaumeGomez force-pushed the fmt_doc branch from 1bd4c9d to 0908d66 Compare May 10, 2016 21:57

steveklabnik added a commit to steveklabnik/rust that referenced this pull request May 11, 2016

Rollup merge of rust-lang#33129 - GuillaumeGomez:fmt_doc, r=steveklabnik

c5e0099

Doc improvement on std::fmt module Part of rust-lang#29355. r? @steveklabnik

steveklabnik mentioned this pull request May 11, 2016

Rollup of 9 pull requests #33556

Merged

bors added a commit that referenced this pull request May 11, 2016

Auto merge of #33556 - steveklabnik:rollup, r=steveklabnik

e37f859

Rollup of 9 pull requests - Successful merges: #33129, #33260, #33345, #33386, #33522, #33524, #33528, #33539, #33542 - Failed merges: #33342, #33475, #33517

bors merged commit 0908d66 into rust-lang:master May 11, 2016

GuillaumeGomez deleted the fmt_doc branch May 17, 2016 11:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc improvement on std::fmt module #33129

Doc improvement on std::fmt module #33129

GuillaumeGomez commented Apr 21, 2016

steveklabnik commented Apr 26, 2016

GuillaumeGomez commented Apr 26, 2016

steveklabnik Apr 26, 2016

GuillaumeGomez Apr 26, 2016 •

edited

Loading

steveklabnik Apr 26, 2016

GuillaumeGomez Apr 26, 2016

GuillaumeGomez commented Apr 27, 2016

steveklabnik commented Apr 29, 2016

bors commented Apr 29, 2016

bors commented Apr 29, 2016

bors commented Apr 29, 2016

GuillaumeGomez commented Apr 29, 2016

steveklabnik commented Apr 30, 2016

GuillaumeGomez commented Apr 30, 2016

steveklabnik commented May 2, 2016

bors commented May 2, 2016

Manishearth commented May 2, 2016

Manishearth commented May 9, 2016

GuillaumeGomez commented May 9, 2016

GuillaumeGomez commented May 10, 2016

Manishearth commented May 10, 2016

mitaa commented May 10, 2016

GuillaumeGomez commented May 10, 2016

mitaa commented May 10, 2016

GuillaumeGomez commented May 10, 2016

steveklabnik commented May 10, 2016

GuillaumeGomez commented May 10, 2016

steveklabnik commented May 11, 2016

bors commented May 11, 2016

Doc improvement on std::fmt module #33129

Doc improvement on std::fmt module #33129

Conversation

GuillaumeGomez commented Apr 21, 2016

steveklabnik commented Apr 26, 2016

GuillaumeGomez commented Apr 26, 2016

steveklabnik Apr 26, 2016

Choose a reason for hiding this comment

GuillaumeGomez Apr 26, 2016 • edited Loading

Choose a reason for hiding this comment

steveklabnik Apr 26, 2016

Choose a reason for hiding this comment

GuillaumeGomez Apr 26, 2016

Choose a reason for hiding this comment

GuillaumeGomez commented Apr 27, 2016

steveklabnik commented Apr 29, 2016

bors commented Apr 29, 2016

bors commented Apr 29, 2016

bors commented Apr 29, 2016

GuillaumeGomez commented Apr 29, 2016

steveklabnik commented Apr 30, 2016

GuillaumeGomez commented Apr 30, 2016

steveklabnik commented May 2, 2016

bors commented May 2, 2016

Manishearth commented May 2, 2016

Manishearth commented May 9, 2016

GuillaumeGomez commented May 9, 2016

GuillaumeGomez commented May 10, 2016

Manishearth commented May 10, 2016

mitaa commented May 10, 2016

GuillaumeGomez commented May 10, 2016

mitaa commented May 10, 2016

GuillaumeGomez commented May 10, 2016

steveklabnik commented May 10, 2016

GuillaumeGomez commented May 10, 2016

steveklabnik commented May 11, 2016

bors commented May 11, 2016

GuillaumeGomez Apr 26, 2016 •

edited

Loading