Skip to content

Commit

Permalink
Rollup merge of rust-lang#75821 - camelid:intra-doc-links-for-std-mac…
Browse files Browse the repository at this point in the history
…ros, r=jyn514

Switch to intra-doc links in `std::macros`

Part of rust-lang#75080.

---

* Switch to intra-doc links in `std::macros`
* Fix typo in module docs
* Link to `std::io::stderr` instead of `std::io::Stderr` to match the
  link text
* Link to `std::io::stdout`

---

@rustbot modify labels: A-intra-doc-links T-doc T-rustdoc
  • Loading branch information
JohnTitor authored Aug 24, 2020
2 parents 9576eef + 637659b commit 8d9086f
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions library/std/src/macros.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! Standard library macros
//!
//! This modules contains a set of macros which are exported from the standard
//! This module contains a set of macros which are exported from the standard
//! library. Each macro is available for use when linking against the standard
//! library.
Expand Down Expand Up @@ -29,9 +29,7 @@ macro_rules! panic {
/// Use `print!` only for the primary output of your program. Use
/// [`eprint!`] instead to print error and progress messages.
///
/// [`println!`]: ../std/macro.println.html
/// [flush]: ../std/io/trait.Write.html#tymethod.flush
/// [`eprint!`]: ../std/macro.eprint.html
/// [flush]: crate::io::Write::flush
///
/// # Panics
///
Expand Down Expand Up @@ -74,12 +72,13 @@ macro_rules! print {
/// Use `println!` only for the primary output of your program. Use
/// [`eprintln!`] instead to print error and progress messages.
///
/// [`format!`]: ../std/macro.format.html
/// [`std::fmt`]: ../std/fmt/index.html
/// [`eprintln!`]: ../std/macro.eprintln.html
/// [`std::fmt`]: crate::fmt
///
/// # Panics
///
/// Panics if writing to `io::stdout` fails.
/// Panics if writing to [`io::stdout`] fails.
///
/// [`io::stdout`]: crate::io::stdout
///
/// # Examples
///
Expand All @@ -101,14 +100,14 @@ macro_rules! println {
/// Prints to the standard error.
///
/// Equivalent to the [`print!`] macro, except that output goes to
/// [`io::stderr`] instead of `io::stdout`. See [`print!`] for
/// [`io::stderr`] instead of [`io::stdout`]. See [`print!`] for
/// example usage.
///
/// Use `eprint!` only for error and progress messages. Use `print!`
/// instead for the primary output of your program.
///
/// [`io::stderr`]: ../std/io/struct.Stderr.html
/// [`print!`]: ../std/macro.print.html
/// [`io::stderr`]: crate::io::stderr
/// [`io::stdout`]: crate::io::stdout
///
/// # Panics
///
Expand All @@ -129,14 +128,14 @@ macro_rules! eprint {
/// Prints to the standard error, with a newline.
///
/// Equivalent to the [`println!`] macro, except that output goes to
/// [`io::stderr`] instead of `io::stdout`. See [`println!`] for
/// [`io::stderr`] instead of [`io::stdout`]. See [`println!`] for
/// example usage.
///
/// Use `eprintln!` only for error and progress messages. Use `println!`
/// instead for the primary output of your program.
///
/// [`io::stderr`]: ../std/io/struct.Stderr.html
/// [`println!`]: ../std/macro.println.html
/// [`io::stderr`]: crate::io::stderr
/// [`io::stdout`]: crate::io::stdout
///
/// # Panics
///
Expand Down

0 comments on commit 8d9086f

Please sign in to comment.