Adding more verbose documentation for `std::fmt::Write`

This commit is contained in:
Dan Vail 2022-08-07 21:02:04 -05:00
parent 93ab13b4e8
commit cc8259e4b6
1 changed files with 7 additions and 0 deletions

View File

@ -119,6 +119,13 @@ pub trait Write {
///
/// This function will return an instance of [`Error`] on error.
///
/// Though it is possible for implementors of this trait to return an error, at the time
/// of writing these docs, no implementation of [`std::fmt::Write`] in the standard library
/// returns such an error.
///
/// When working with external crates, it is advised to check the implementation of this
/// trait and anticipate any possible [`Error`]s.
///
/// # Examples
///
/// ```