doc: format! may or may not handle streams in future

[tshepang]

No need to talk about that here

[rust-highfive]

r? @brson

(rust_highfive has picked a reviewer for you, use r? to override)

[mhristache]

I think you removed a bit too much text as it's important info that format! returns a String.

[brson]

If you are removing references to streams please remove the one from the first para too: "This macro is implemented in the compiler to emit calls to this module in order to format arguments at runtime into strings and streams."

@maximih that first paragraph also mentions that format returns strings so maybe is sufficient. @tshepang maybe this sentence can be changed to be more clear about creating String.

If we're removing irrelevant info, the detail that format! is implemented in the compiler is hardly the first thing I would call out in the docs.

[birkenfeld]

Isn't write!()/writeln!() what's used to write to streams? In that case it could just be linked to.

[tshepang]

@brson I don't understand this:

If we're removing irrelevant info, the detail that format! is implemented in the compiler is hardly the first thing I would call out in the docs.

[brson]

@tshepang The second sentence of the description of format! begins with "This macro is implemented in the compiler". I was just saying that that bit of information is irrelevant to users.

[brson]

@bors r+ rollup

[bors]

📌 Commit 5c34892 has been approved by brson