From a82867c2bc270ec7dd746f4c8b5ffd766852addc Mon Sep 17 00:00:00 2001 From: Yuri Astrakhan Date: Mon, 23 Sep 2024 17:31:25 -0400 Subject: [PATCH] Minor doc improvement Use more concise `read_to_string` to read file content. --- src/file.rs | 11 +++-------- src/lib.rs | 9 +++------ 2 files changed, 6 insertions(+), 14 deletions(-) diff --git a/src/file.rs b/src/file.rs index 681125e137..93a36a8d23 100644 --- a/src/file.rs +++ b/src/file.rs @@ -15,8 +15,7 @@ ast_struct! { /// /// ``` /// use std::env; - /// use std::fs::File; - /// use std::io::Read; + /// use std::fs::read_to_string; /// use std::process; /// /// fn main() { @@ -34,15 +33,11 @@ ast_struct! { /// } /// }; /// - /// let mut file = File::open(&filename).expect("unable to open file"); - /// - /// let mut src = String::new(); - /// file.read_to_string(&mut src).expect("unable to read file"); - /// + /// let src = read_to_string(&filename).expect("unable to read file"); /// let syntax = syn::parse_file(&src).expect("unable to parse file"); /// /// // Debug impl is available if Syn is built with "extra-traits" feature. - /// println!("{:#?}", syntax); + /// println!("{syntax:#?}"); /// } /// ``` /// diff --git a/src/lib.rs b/src/lib.rs index 0da4204426..98722c97f2 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -973,17 +973,14 @@ pub fn parse_str(s: &str) -> Result { /// /// ```no_run /// use std::error::Error; -/// use std::fs::File; +/// use std::fs::read_to_string; /// use std::io::Read; /// /// fn run() -> Result<(), Box> { -/// let mut file = File::open("path/to/code.rs")?; -/// let mut content = String::new(); -/// file.read_to_string(&mut content)?; -/// +/// let content = read_to_string("path/to/code.rs")?; /// let ast = syn::parse_file(&content)?; /// if let Some(shebang) = ast.shebang { -/// println!("{}", shebang); +/// println!("{shebang}"); /// } /// println!("{} items", ast.items.len()); ///