Skip to content

Commit 8a472a5

Browse files
committed
Add a more complete doc example for 'include' macro.
1 parent 1b38776 commit 8a472a5

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

src/libstd/macros.rs

+17-2
Original file line numberDiff line numberDiff line change
@@ -470,11 +470,26 @@ pub mod builtin {
470470
///
471471
/// # Examples
472472
///
473+
/// Assume there are two files in the same directory with the following
474+
/// contents:
475+
///
476+
/// File 'my_str.in':
477+
///
473478
/// ```ignore
474-
/// fn foo() {
475-
/// include!("/path/to/a/file")
479+
/// "Hello World!"
480+
/// ```
481+
///
482+
/// File 'main.rs':
483+
///
484+
/// ```ignore
485+
/// fn main() {
486+
/// let my_str = include!("my_str.in");
487+
/// println!("{}", my_str);
476488
/// }
477489
/// ```
490+
///
491+
/// Compiling 'main.rs' and running the resulting binary will print "Hello
492+
/// World!".
478493
#[stable(feature = "rust1", since = "1.0.0")]
479494
#[macro_export]
480495
macro_rules! include { ($file:expr) => ({ /* compiler built-in */ }) }

0 commit comments

Comments
 (0)