1- /// Entry point of thread panic. For details, see `std::macros`. 
1+ /// Panics the current thread. 
2+ /// 
3+ /// For details, see `std::macros`. 
24#[ macro_export]  
35#[ allow_internal_unstable( core_panic,  __rust_unstable_column) ]  
46#[ stable( feature = "core" ,  since = "1.6.0" ) ]  
@@ -132,7 +134,7 @@ macro_rules! assert_ne {
132134    } ) ; 
133135} 
134136
135- /// Ensure  that a boolean expression is `true` at runtime. 
137+ /// Asserts  that a boolean expression is `true` at runtime. 
136138/// 
137139/// This will invoke the [`panic!`] macro if the provided expression cannot be 
138140/// evaluated to `true` at runtime. 
@@ -236,8 +238,7 @@ macro_rules! debug_assert_ne {
236238    ( $( $arg: tt) * )  => ( if  cfg!( debug_assertions)  {  assert_ne!( $( $arg) * ) ;  } ) 
237239} 
238240
239- /// Helper macro for reducing boilerplate code for matching `Result` together 
240- /// with converting downstream errors. 
241+ /// Unwraps a result or propagates its error. 
241242/// 
242243/// The `?` operator was added to replace `try!` and should be used instead. 
243244/// Furthermore, `try` is a reserved word in Rust 2018, so if you must use 
@@ -312,7 +313,7 @@ macro_rules! r#try {
312313    ( $expr: expr, )  => ( r#try!( $expr) ) ; 
313314} 
314315
315- /// Write  formatted data into a buffer. 
316+ /// Writes  formatted data into a buffer. 
316317/// 
317318/// This macro accepts a format string, a list of arguments, and a 'writer'. Arguments will be 
318319/// formatted according to the specified format string and the result will be passed to the writer. 
@@ -434,7 +435,7 @@ macro_rules! writeln {
434435    ) ; 
435436} 
436437
437- /// A utility macro for indicating  unreachable code. 
438+ /// Indicates  unreachable code. 
438439/// 
439440/// This is useful any time that the compiler can't determine that some code is unreachable. For 
440441/// example: 
@@ -502,7 +503,7 @@ macro_rules! unreachable {
502503    } ) ; 
503504} 
504505
505- /// A standardized placeholder for marking  unfinished code. 
506+ /// Indicates  unfinished code. 
506507/// 
507508/// This can be useful if you are prototyping and are just looking to have your 
508509/// code type-check, or if you're implementing a trait that requires multiple 
@@ -559,10 +560,10 @@ macro_rules! unimplemented {
559560    ( $( $arg: tt) +)  => ( panic!( "not yet implemented: {}" ,  format_args!( $( $arg) * ) ) ) ; 
560561} 
561562
562- /// A standardized placeholder for marking  unfinished code. 
563+ /// Indicates  unfinished code. 
563564/// 
564565/// This can be useful if you are prototyping and are just looking to have your 
565- /// code typecheck. `todo!` works exactly like `unimplemented!`, there  only 
566+ /// code typecheck. `todo!` works exactly like `unimplemented!`. The  only 
566567/// difference between the two macros is the name. 
567568/// 
568569/// # Panics 
@@ -618,7 +619,7 @@ macro_rules! todo {
618619    ( $( $arg: tt) +)  => ( panic!( "not yet implemented: {}" ,  format_args!( $( $arg) * ) ) ) ; 
619620} 
620621
621- /// A macro to create  an array of [`MaybeUninit`] 
622+ /// Creates  an array of [`MaybeUninit`].  
622623/// 
623624/// This macro constructs an uninitialized array of the type `[MaybeUninit<K>; N]`. 
624625/// 
@@ -645,7 +646,7 @@ macro_rules! uninitialized_array {
645646#[ cfg( rustdoc) ]  
646647mod  builtin { 
647648
648-     /// Unconditionally causes  compilation to fail with the given error message when encountered. 
649+     /// Causes  compilation to fail with the given error message when encountered. 
649650     /// 
650651     /// For more information, see the documentation for [`std::compile_error!`]. 
651652     /// 
@@ -657,7 +658,7 @@ mod builtin {
657658        ( $msg: expr, )  => ( {  /* compiler built-in */  } ) ; 
658659    } 
659660
660-     /// The core macro  for formatted  string creation & output . 
661+     /// Constructs parameters  for the other  string-formatting macros . 
661662     /// 
662663     /// For more information, see the documentation for [`std::format_args!`]. 
663664     /// 
@@ -669,7 +670,7 @@ mod builtin {
669670        ( $fmt: expr,  $( $args: tt) * )  => ( {  /* compiler built-in */  } ) ; 
670671    } 
671672
672-     /// Inspect  an environment variable at compile time. 
673+     /// Inspects  an environment variable at compile time. 
673674     /// 
674675     /// For more information, see the documentation for [`std::env!`]. 
675676     /// 
@@ -681,7 +682,7 @@ mod builtin {
681682        ( $name: expr, )  => ( {  /* compiler built-in */  } ) ; 
682683    } 
683684
684-     /// Optionally inspect  an environment variable at compile time. 
685+     /// Optionally inspects  an environment variable at compile time. 
685686     /// 
686687     /// For more information, see the documentation for [`std::option_env!`]. 
687688     /// 
@@ -693,7 +694,7 @@ mod builtin {
693694        ( $name: expr, )  => ( {  /* compiler built-in */  } ) ; 
694695    } 
695696
696-     /// Concatenate  identifiers into one identifier. 
697+     /// Concatenates  identifiers into one identifier. 
697698     /// 
698699     /// For more information, see the documentation for [`std::concat_idents!`]. 
699700     /// 
@@ -717,7 +718,7 @@ mod builtin {
717718        ( $( $e: expr, ) * )  => ( {  /* compiler built-in */  } ) ; 
718719    } 
719720
720-     /// A macro which expands  to the line number on which it was invoked. 
721+     /// Expands  to the line number on which it was invoked. 
721722     /// 
722723     /// For more information, see the documentation for [`std::line!`]. 
723724     /// 
@@ -726,7 +727,7 @@ mod builtin {
726727    #[ rustc_doc_only_macro]  
727728    macro_rules!  line {  ( )  => ( {  /* compiler built-in */  } )  } 
728729
729-     /// A macro which expands  to the column number on which it was invoked. 
730+     /// Expands  to the column number on which it was invoked. 
730731     /// 
731732     /// For more information, see the documentation for [`std::column!`]. 
732733     /// 
@@ -735,7 +736,7 @@ mod builtin {
735736    #[ rustc_doc_only_macro]  
736737    macro_rules!  column {  ( )  => ( {  /* compiler built-in */  } )  } 
737738
738-     /// A macro which expands  to the file name from which it was invoked. 
739+     /// Expands  to the file name from which it was invoked. 
739740     /// 
740741     /// For more information, see the documentation for [`std::file!`]. 
741742     /// 
@@ -744,7 +745,7 @@ mod builtin {
744745    #[ rustc_doc_only_macro]  
745746    macro_rules!  file {  ( )  => ( {  /* compiler built-in */  } )  } 
746747
747-     /// A macro which stringifies  its arguments. 
748+     /// Stringifies  its arguments. 
748749     /// 
749750     /// For more information, see the documentation for [`std::stringify!`]. 
750751     /// 
@@ -786,7 +787,7 @@ mod builtin {
786787    #[ rustc_doc_only_macro]  
787788    macro_rules!  module_path {  ( )  => ( {  /* compiler built-in */  } )  } 
788789
789-     /// Boolean evaluation  of configuration flags, at compile-time. 
790+     /// Evaluates boolean combinations  of configuration flags, at compile-time. 
790791     /// 
791792     /// For more information, see the documentation for [`std::cfg!`]. 
792793     /// 
@@ -795,7 +796,7 @@ mod builtin {
795796    #[ rustc_doc_only_macro]  
796797    macro_rules!  cfg {  ( $( $cfg: tt) * )  => ( {  /* compiler built-in */  } )  } 
797798
798-     /// Parse  a file as an expression or an item according to the context. 
799+     /// Parses  a file as an expression or an item according to the context. 
799800     /// 
800801     /// For more information, see the documentation for [`std::include!`]. 
801802     /// 
@@ -807,7 +808,7 @@ mod builtin {
807808        ( $file: expr, )  => ( {  /* compiler built-in */  } ) ; 
808809    } 
809810
810-     /// Ensure  that a boolean expression is `true` at runtime. 
811+     /// Asserts  that a boolean expression is `true` at runtime. 
811812     /// 
812813     /// For more information, see the documentation for [`std::assert!`]. 
813814     /// 
0 commit comments