@@ -316,26 +316,27 @@ macro_rules! try {
316316
317317/// Write formatted data into a buffer
318318///
319- /// This macro accepts any value with `write_fmt` method as a writer , a format string, and a list
320- /// of arguments to format.
319+ /// This macro accepts a 'writer' ( any value with a `write_fmt` method) , a format string, and a
320+ /// list of arguments to format.
321321///
322- /// `write_fmt` method usually comes from an implementation of [`std::fmt::Write`][fmt_write] or
323- /// [`std::io::Write`][io_write] traits. These are sometimes called 'writers'.
322+ /// The `write_fmt` method usually comes from an implementation of [`std::fmt::Write`][fmt_write]
323+ /// or [`std::io::Write`][io_write] traits. The term 'writer' refers to an implementation of one of
324+ /// these two traits.
324325///
325326/// Passed arguments will be formatted according to the specified format string and the resulting
326327/// string will be passed to the writer.
327328///
328329/// See [`std::fmt`][fmt] for more information on format syntax.
329330///
330- /// Return value is completely dependent on the 'write_fmt' method.
331+ /// `write!` returns whatever the 'write_fmt' method returns .
331332///
332- /// Common return values are : [`Result`][enum_result ], [`io::Result`][type_result ]
333+ /// Common return values include : [`fmt:: Result`][fmt_result ], [`io::Result`][io_result ]
333334///
334335/// [fmt]: ../std/fmt/index.html
335336/// [fmt_write]: ../std/fmt/trait.Write.html
336337/// [io_write]: ../std/io/trait.Write.html
337- /// [enum_result ]: ../std/result/enum .Result.html
338- /// [type_result ]: ../std/io/type.Result.html
338+ /// [fmt_result ]: ../std/fmt/type .Result.html
339+ /// [io_result ]: ../std/io/type.Result.html
339340///
340341/// # Examples
341342///
@@ -354,31 +355,32 @@ macro_rules! write {
354355 ( $dst: expr, $( $arg: tt) * ) => ( $dst. write_fmt( format_args!( $( $arg) * ) ) )
355356}
356357
357- /// Write formatted data into a buffer, with appending a newline.
358+ /// Write formatted data into a buffer, with a newline appended .
358359///
359360/// On all platforms, the newline is the LINE FEED character (`\n`/`U+000A`) alone
360361/// (no additional CARRIAGE RETURN (`\r`/`U+000D`).
361362///
362- /// This macro accepts any value with `write_fmt` method as a writer , a format string, and a list
363- /// of arguments to format.
363+ /// This macro accepts a 'writer' ( any value with a `write_fmt` method) , a format string, and a
364+ /// list of arguments to format.
364365///
365- /// `write_fmt` method usually comes from an implementation of [`std::fmt::Write`][fmt_write] or
366- /// [`std::io::Write`][io_write] traits. These are sometimes called 'writers'.
366+ /// The `write_fmt` method usually comes from an implementation of [`std::fmt::Write`][fmt_write]
367+ /// or [`std::io::Write`][io_write] traits. The term 'writer' refers to an implementation of one of
368+ /// these two traits.
367369///
368370/// Passed arguments will be formatted according to the specified format string and the resulting
369- /// string will be passed to the writer.
371+ /// string will be passed to the writer, along with the appended newline .
370372///
371373/// See [`std::fmt`][fmt] for more information on format syntax.
372374///
373- /// Return value is completely dependent on the 'write_fmt' method.
375+ /// `write!` returns whatever the 'write_fmt' method returns .
374376///
375- /// Common return values are : [`Result`][enum_result ], [`io::Result`][type_result ]
377+ /// Common return values include : [`fmt:: Result`][fmt_result ], [`io::Result`][io_result ]
376378///
377379/// [fmt]: ../std/fmt/index.html
378380/// [fmt_write]: ../std/fmt/trait.Write.html
379381/// [io_write]: ../std/io/trait.Write.html
380- /// [enum_result ]: ../std/result/enum .Result.html
381- /// [type_result ]: ../std/io/type.Result.html
382+ /// [fmt_result ]: ../std/fmt/type .Result.html
383+ /// [io_result ]: ../std/io/type.Result.html
382384///
383385/// # Examples
384386///
0 commit comments