Skip to content

Commit 55159e8

Browse files
ijacksonRalfJung
authored andcommitted
print macros: add xrefs to format syntax documentation
1 parent 1116707 commit 55159e8

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

library/std/src/macros.rs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ macro_rules! panic {
4141
/// Use `print!` only for the primary output of your program. Use
4242
/// [`eprint!`] instead to print error and progress messages.
4343
///
44+
/// See [the formatting documentation in `std::fmt`](../std/fmt/index.html)
45+
/// for details of the macro argument syntax.
46+
///
4447
/// [flush]: crate::io::Write::flush
4548
/// [`println!`]: crate::println
4649
/// [`eprint!`]: crate::eprint
@@ -103,6 +106,9 @@ macro_rules! print {
103106
/// Use `println!` only for the primary output of your program. Use
104107
/// [`eprintln!`] instead to print error and progress messages.
105108
///
109+
/// See [the formatting documentation in `std::fmt`](../std/fmt/index.html)
110+
/// for details of the macro argument syntax.
111+
///
106112
/// [`std::fmt`]: crate::fmt
107113
/// [`eprintln!`]: crate::eprintln
108114
/// [lock]: crate::io::Stdout
@@ -150,6 +156,9 @@ macro_rules! println {
150156
/// [`io::stderr`]: crate::io::stderr
151157
/// [`io::stdout`]: crate::io::stdout
152158
///
159+
/// See [the formatting documentation in `std::fmt`](../std/fmt/index.html)
160+
/// for details of the macro argument syntax.
161+
///
153162
/// # Panics
154163
///
155164
/// Panics if writing to `io::stderr` fails.
@@ -181,6 +190,9 @@ macro_rules! eprint {
181190
/// Use `eprintln!` only for error and progress messages. Use `println!`
182191
/// instead for the primary output of your program.
183192
///
193+
/// See [the formatting documentation in `std::fmt`](../std/fmt/index.html)
194+
/// for details of the macro argument syntax.
195+
///
184196
/// [`io::stderr`]: crate::io::stderr
185197
/// [`io::stdout`]: crate::io::stdout
186198
/// [`println!`]: crate::println

0 commit comments

Comments
 (0)