api-guidelines
api-guidelines copied to clipboard
C-QUESTION-MARK: Use simpler main error type syntax
According to the rustdoc book:
As of version 1.34.0, one can also omit the fn main(), but you will have to disambiguate the error type:
/// ``` /// use std::io; /// let mut input = String::new(); /// io::stdin().read_line(&mut input)?; /// # Ok::<(), io::Error>(()) /// ```
The C-QUESTION-MARK example should adopt this new syntax, since this syntactic sugar encourages doc authors to adopt the ? syntax without a lot of ugly boilerplate.
This would be a nice bit of gardening if anybody would like to tidy up the example blocks!
I could not find other example blocks where this change would be applicable @KodrAus