mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

format, format_args: Make xref to std::fmt much more prominent

Browse Source 
That xref contains the actual documentation for what format! does.
It should be very prominent - particularly, more so than the other
links.
This commit is contained in:
Ian Jackson 2022-04-28 14:27:57 +01:00 committed by Ralf Jung
parent 2ec8b6b50f
commit 39c642e3d2
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
library/alloc/src/macros.rs
View File

@ -79,10 +79,12 @@ macro_rules! vec {
/// ///
/// The first argument `format!` receives is a format string. This must be a string /// The first argument `format!` receives is a format string. This must be a string
/// literal. The power of the formatting string is in the `{}`s contained. /// literal. The power of the formatting string is in the `{}`s contained.
///
/// Additional parameters passed to `format!` replace the `{}`s within the /// Additional parameters passed to `format!` replace the `{}`s within the
/// formatting string in the order given unless named or positional parameters /// formatting string in the order given unless named or positional parameters
/// are used; see [`std::fmt`] for more information. /// are used.
///
/// See [the formatting syntax documentation in `std::fmt`](../std/fmt/index.html)
/// for details.
/// ///
/// A common use for `format!` is concatenation and interpolation of strings. /// A common use for `format!` is concatenation and interpolation of strings.
/// The same convention is used with [`print!`] and [`write!`] macros, /// The same convention is used with [`print!`] and [`write!`] macros,
@ -91,7 +93,6 @@ macro_rules! vec {
/// To convert a single value to a string, use the [`to_string`] method. This /// To convert a single value to a string, use the [`to_string`] method. This
/// will use the [`Display`] formatting trait. /// will use the [`Display`] formatting trait.
/// ///
/// [`std::fmt`]: ../std/fmt/index.html
/// [`print!`]: ../std/macro.print.html /// [`print!`]: ../std/macro.print.html
/// [`write!`]: core::write /// [`write!`]: core::write
/// [`to_string`]: crate::string::ToString /// [`to_string`]: crate::string::ToString

3
library/core/src/macros/mod.rs
View File

@ -849,7 +849,8 @@ pub(crate) mod builtin {
/// assert_eq!(display, debug); /// assert_eq!(display, debug);
/// ``` /// ```
/// ///
/// For more information, see the documentation in [`std::fmt`]. /// See [the formatting documentation in `std::fmt`](../std/fmt/index.html)
/// for details of the macro argument syntax, and further information.
/// ///
/// [`Display`]: crate::fmt::Display /// [`Display`]: crate::fmt::Display
/// [`Debug`]: crate::fmt::Debug /// [`Debug`]: crate::fmt::Debug