Auto merge of #28047 - steveklabnik:doc_print, r=alexcrichton

1 files changed, 20 insertions, 0 deletions

diff --git a/src/libstd/macros.rs b/src/libstd/macros.rs
index 317130f5f0e..e4866982176 100644
--- a/src/libstd/macros.rs
+++ b/src/libstd/macros.rs
@@ -67,6 +67,26 @@ macro_rules! panic {
 /// Note that stdout is frequently line-buffered by default so it may be
 /// necessary to use `io::stdout().flush()` to ensure the output is emitted
 /// immediately.
+///
+/// # Examples
+///
+/// ```
+/// use std::io::{self, Write};
+///
+/// print!("this ");
+/// print!("will ");
+/// print!("be ");
+/// print!("on ");
+/// print!("the ");
+/// print!("same ");
+/// print!("line ");
+///
+/// io::stdout().flush().unwrap();
+///
+/// print!("this string has a newline, why not choose println! instead?\n");
+///
+/// io::stdout().flush().unwrap();
+/// ```
 #[macro_export]
 #[stable(feature = "rust1", since = "1.0.0")]
 #[allow_internal_unstable]