Skip to content

Commit

Permalink
Rollup merge of rust-lang#59448 - benesch:macro-doc, r=Centril
Browse files Browse the repository at this point in the history 
Use consistent phrasing for all macro summaries

None
  • Loading branch information
@Centril
Centril authored Mar 28, 2019
2 parents 02c1e3d + 3e0db7c commit 2ee038a
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 44 deletions.
45 changes: 23 additions & 22 deletions src/libcore/macros.rs
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
/// Entry point of thread panic. For details, see `std::macros`.
/// Panics the current thread.
///
/// For details, see `std::macros`.
#[macro_export]
#[allow_internal_unstable(core_panic, __rust_unstable_column)]
#[stable(feature = "core", since = "1.6.0")]
Expand Down Expand Up @@ -132,7 +134,7 @@ macro_rules! assert_ne {
});
}

/// Ensure that a boolean expression is `true` at runtime.
/// Asserts that a boolean expression is `true` at runtime.
///
/// This will invoke the [`panic!`] macro if the provided expression cannot be
/// evaluated to `true` at runtime.
Expand Down Expand Up @@ -236,8 +238,7 @@ macro_rules! debug_assert_ne {
($($arg:tt)*) => (if cfg!(debug_assertions) { assert_ne!($($arg)*); })
}

/// Helper macro for reducing boilerplate code for matching `Result` together
/// with converting downstream errors.
/// Unwraps a result or propagates its error.
///
/// The `?` operator was added to replace `try!` and should be used instead.
/// Furthermore, `try` is a reserved word in Rust 2018, so if you must use
Expand Down Expand Up @@ -312,7 +313,7 @@ macro_rules! r#try {
($expr:expr,) => (r#try!($expr));
}

/// Write formatted data into a buffer.
/// Writes formatted data into a buffer.
///
/// This macro accepts a format string, a list of arguments, and a 'writer'. Arguments will be
/// formatted according to the specified format string and the result will be passed to the writer.
Expand Down Expand Up @@ -434,7 +435,7 @@ macro_rules! writeln {
);
}

/// A utility macro for indicating unreachable code.
/// Indicates unreachable code.
///
/// This is useful any time that the compiler can't determine that some code is unreachable. For
/// example:
Expand Down Expand Up @@ -502,7 +503,7 @@ macro_rules! unreachable {
});
}

/// A standardized placeholder for marking unfinished code.
/// Indicates unfinished code.
///
/// This can be useful if you are prototyping and are just looking to have your
/// code type-check, or if you're implementing a trait that requires multiple
Expand Down Expand Up @@ -559,10 +560,10 @@ macro_rules! unimplemented {
($($arg:tt)+) => (panic!("not yet implemented: {}", format_args!($($arg)*)));
}

/// A standardized placeholder for marking unfinished code.
/// Indicates unfinished code.
///
/// This can be useful if you are prototyping and are just looking to have your
/// code typecheck. `todo!` works exactly like `unimplemented!`, there only
/// code typecheck. `todo!` works exactly like `unimplemented!`. The only
/// difference between the two macros is the name.
///
/// # Panics
Expand Down Expand Up @@ -618,7 +619,7 @@ macro_rules! todo {
($($arg:tt)+) => (panic!("not yet implemented: {}", format_args!($($arg)*)));
}

/// A macro to create an array of [`MaybeUninit`]
/// Creates an array of [`MaybeUninit`].
///
/// This macro constructs an uninitialized array of the type `[MaybeUninit<K>; N]`.
///
Expand All @@ -645,7 +646,7 @@ macro_rules! uninitialized_array {
#[cfg(rustdoc)]
mod builtin {

/// Unconditionally causes compilation to fail with the given error message when encountered.
/// Causes compilation to fail with the given error message when encountered.
///
/// For more information, see the documentation for [`std::compile_error!`].
///
Expand All @@ -657,7 +658,7 @@ mod builtin {
($msg:expr,) => ({ /* compiler built-in */ });
}

/// The core macro for formatted string creation & output.
/// Constructs parameters for the other string-formatting macros.
///
/// For more information, see the documentation for [`std::format_args!`].
///
Expand All @@ -669,7 +670,7 @@ mod builtin {
($fmt:expr, $($args:tt)*) => ({ /* compiler built-in */ });
}

/// Inspect an environment variable at compile time.
/// Inspects an environment variable at compile time.
///
/// For more information, see the documentation for [`std::env!`].
///
Expand All @@ -681,7 +682,7 @@ mod builtin {
($name:expr,) => ({ /* compiler built-in */ });
}

/// Optionally inspect an environment variable at compile time.
/// Optionally inspects an environment variable at compile time.
///
/// For more information, see the documentation for [`std::option_env!`].
///
Expand All @@ -693,7 +694,7 @@ mod builtin {
($name:expr,) => ({ /* compiler built-in */ });
}

/// Concatenate identifiers into one identifier.
/// Concatenates identifiers into one identifier.
///
/// For more information, see the documentation for [`std::concat_idents!`].
///
Expand All @@ -717,7 +718,7 @@ mod builtin {
($($e:expr,)*) => ({ /* compiler built-in */ });
}

/// A macro which expands to the line number on which it was invoked.
/// Expands to the line number on which it was invoked.
///
/// For more information, see the documentation for [`std::line!`].
///
Expand All @@ -726,7 +727,7 @@ mod builtin {
#[rustc_doc_only_macro]
macro_rules! line { () => ({ /* compiler built-in */ }) }

/// A macro which expands to the column number on which it was invoked.
/// Expands to the column number on which it was invoked.
///
/// For more information, see the documentation for [`std::column!`].
///
Expand All @@ -735,7 +736,7 @@ mod builtin {
#[rustc_doc_only_macro]
macro_rules! column { () => ({ /* compiler built-in */ }) }

/// A macro which expands to the file name from which it was invoked.
/// Expands to the file name from which it was invoked.
///
/// For more information, see the documentation for [`std::file!`].
///
Expand All @@ -744,7 +745,7 @@ mod builtin {
#[rustc_doc_only_macro]
macro_rules! file { () => ({ /* compiler built-in */ }) }

/// A macro which stringifies its arguments.
/// Stringifies its arguments.
///
/// For more information, see the documentation for [`std::stringify!`].
///
Expand Down Expand Up @@ -786,7 +787,7 @@ mod builtin {
#[rustc_doc_only_macro]
macro_rules! module_path { () => ({ /* compiler built-in */ }) }

/// Boolean evaluation of configuration flags, at compile-time.
/// Evaluates boolean combinations of configuration flags, at compile-time.
///
/// For more information, see the documentation for [`std::cfg!`].
///
Expand All @@ -795,7 +796,7 @@ mod builtin {
#[rustc_doc_only_macro]
macro_rules! cfg { ($($cfg:tt)*) => ({ /* compiler built-in */ }) }

/// Parse a file as an expression or an item according to the context.
/// Parses a file as an expression or an item according to the context.
///
/// For more information, see the documentation for [`std::include!`].
///
Expand All @@ -807,7 +808,7 @@ mod builtin {
($file:expr,) => ({ /* compiler built-in */ });
}

/// Ensure that a boolean expression is `true` at runtime.
/// Asserts that a boolean expression is `true` at runtime.
///
/// For more information, see the documentation for [`std::assert!`].
///
Expand Down
46 changes: 24 additions & 22 deletions src/libstd/macros.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
//! library. Each macro is available for use when linking against the standard
//! library.
/// The entry point for panic of Rust threads.
/// Panics the current thread.
///
/// This allows a program to terminate immediately and provide feedback
/// to the caller of the program. `panic!` should be used when a program reaches
Expand Down Expand Up @@ -70,7 +70,7 @@ macro_rules! panic {
});
}

/// Macro for printing to the standard output.
/// Prints to the standard output.
///
/// Equivalent to the [`println!`] macro except that a newline is not printed at
/// the end of the message.
Expand Down Expand Up @@ -116,7 +116,7 @@ macro_rules! print {
($($arg:tt)*) => ($crate::io::_print(format_args!($($arg)*)));
}

/// Macro for printing to the standard output, with a newline.
/// Prints to the standard output, with a newline.
///
/// On all platforms, the newline is the LINE FEED character (`\n`/`U+000A`) alone
/// (no additional CARRIAGE RETURN (`\r`/`U+000D`).
Expand Down Expand Up @@ -151,7 +151,7 @@ macro_rules! println {
})
}

/// Macro for printing to the standard error.
/// Prints to the standard error.
///
/// Equivalent to the [`print!`] macro, except that output goes to
/// [`io::stderr`] instead of `io::stdout`. See [`print!`] for
Expand Down Expand Up @@ -179,7 +179,7 @@ macro_rules! eprint {
($($arg:tt)*) => ($crate::io::_eprint(format_args!($($arg)*)));
}

/// Macro for printing to the standard error, with a newline.
/// 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
Expand Down Expand Up @@ -210,8 +210,10 @@ macro_rules! eprintln {
})
}

/// A macro for quick and dirty debugging with which you can inspect
/// the value of a given expression. An example:
/// Prints and returns the value of a given expression for quick and dirty
/// debugging.
///
/// An example:
///
/// ```rust
/// let a = 2;
Expand Down Expand Up @@ -328,7 +330,7 @@ macro_rules! dbg {
}
}

/// A macro to await on an async call.
/// Awaits the completion of an async call.
#[macro_export]
#[unstable(feature = "await_macro", issue = "50547")]
#[allow_internal_unstable(gen_future, generators)]
Expand All @@ -351,7 +353,7 @@ macro_rules! r#await {
} }
}

/// A macro to select an event from a number of receivers.
/// Selects the first successful receive event from a number of receivers.
///
/// This macro is used to wait for the first event to occur on a number of
/// receivers. It places no restrictions on the types of receivers given to
Expand Down Expand Up @@ -423,7 +425,7 @@ macro_rules! assert_approx_eq {
#[cfg(rustdoc)]
mod builtin {

/// Unconditionally causes compilation to fail with the given error message when encountered.
/// Causes compilation to fail with the given error message when encountered.
///
/// This macro should be used when a crate uses a conditional compilation strategy to provide
/// better error messages for erroneous conditions. It's the compiler-level form of [`panic!`],
Expand Down Expand Up @@ -465,7 +467,7 @@ mod builtin {
($msg:expr,) => ({ /* compiler built-in */ });
}

/// The core macro for formatted string creation & output.
/// Constructs parameters for the other string-formatting macros.
///
/// This macro functions by taking a formatting string literal containing
/// `{}` for each additional argument passed. `format_args!` prepares the
Expand Down Expand Up @@ -517,7 +519,7 @@ mod builtin {
($fmt:expr, $($args:tt)*) => ({ /* compiler built-in */ });
}

/// Inspect an environment variable at compile time.
/// Inspects an environment variable at compile time.
///
/// This macro will expand to the value of the named environment variable at
/// compile time, yielding an expression of type `&'static str`.
Expand Down Expand Up @@ -555,7 +557,7 @@ mod builtin {
($name:expr,) => ({ /* compiler built-in */ });
}

/// Optionally inspect an environment variable at compile time.
/// Optionally inspects an environment variable at compile time.
///
/// If the named environment variable is present at compile time, this will
/// expand into an expression of type `Option<&'static str>` whose value is
Expand All @@ -581,7 +583,7 @@ mod builtin {
($name:expr,) => ({ /* compiler built-in */ });
}

/// Concatenate identifiers into one identifier.
/// Concatenates identifiers into one identifier.
///
/// This macro takes any number of comma-separated identifiers, and
/// concatenates them all into one, yielding an expression which is a new
Expand Down Expand Up @@ -634,7 +636,7 @@ mod builtin {
($($e:expr,)*) => ({ /* compiler built-in */ });
}

/// A macro which expands to the line number on which it was invoked.
/// Expands to the line number on which it was invoked.
///
/// With [`column!`] and [`file!`], these macros provide debugging information for
/// developers about the location within the source.
Expand All @@ -659,7 +661,7 @@ mod builtin {
#[rustc_doc_only_macro]
macro_rules! line { () => ({ /* compiler built-in */ }) }

/// A macro which expands to the column number on which it was invoked.
/// Expands to the column number at which it was invoked.
///
/// With [`line!`] and [`file!`], these macros provide debugging information for
/// developers about the location within the source.
Expand All @@ -684,7 +686,7 @@ mod builtin {
#[rustc_doc_only_macro]
macro_rules! column { () => ({ /* compiler built-in */ }) }

/// A macro which expands to the file name from which it was invoked.
/// Expands to the file name in which it was invoked.
///
/// With [`line!`] and [`column!`], these macros provide debugging information for
/// developers about the location within the source.
Expand All @@ -708,7 +710,7 @@ mod builtin {
#[rustc_doc_only_macro]
macro_rules! file { () => ({ /* compiler built-in */ }) }

/// A macro which stringifies its arguments.
/// Stringifies its arguments.
///
/// This macro will yield an expression of type `&'static str` which is the
/// stringification of all the tokens passed to the macro. No restrictions
Expand Down Expand Up @@ -822,7 +824,7 @@ mod builtin {
#[rustc_doc_only_macro]
macro_rules! module_path { () => ({ /* compiler built-in */ }) }

/// Boolean evaluation of configuration flags, at compile-time.
/// Evaluates boolean combinations of configuration flags at compile-time.
///
/// In addition to the `#[cfg]` attribute, this macro is provided to allow
/// boolean expression evaluation of configuration flags. This frequently
Expand All @@ -844,7 +846,7 @@ mod builtin {
#[rustc_doc_only_macro]
macro_rules! cfg { ($($cfg:tt)*) => ({ /* compiler built-in */ }) }

/// Parse a file as an expression or an item according to the context.
/// Parses a file as an expression or an item according to the context.
///
/// The file is located relative to the current file (similarly to how
/// modules are found).
Expand Down Expand Up @@ -890,7 +892,7 @@ mod builtin {
($file:expr,) => ({ /* compiler built-in */ });
}

/// Ensure that a boolean expression is `true` at runtime.
/// Asserts that a boolean expression is `true` at runtime.
///
/// This will invoke the [`panic!`] macro if the provided expression cannot be
/// evaluated to `true` at runtime.
Expand Down Expand Up @@ -944,7 +946,7 @@ mod builtin {
}
}

/// A macro for defining `#[cfg]` if-else statements.
/// Defines `#[cfg]` if-else statements.
///
/// This is similar to the `if/elif` C preprocessor macro by allowing definition
/// of a cascade of `#[cfg]` cases, emitting the implementation which matches
Expand Down

0 comments on commit 2ee038a

Please sign in to comment.