Rollup merge of #100255 - thedanvail:issue-98861-fix, r=joshtriplett

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

Attempts to address #98861
This commit is contained in:
Dylan DPC 2022-08-12 20:39:13 +05:30 committed by GitHub
commit da3b89d0bf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -119,6 +119,10 @@ pub trait Write {
/// ///
/// This function will return an instance of [`Error`] on error. /// This function will return an instance of [`Error`] on error.
/// ///
/// The purpose of std::fmt::Error is to abort the formatting operation when the underlying
/// destination encounters some error preventing it from accepting more text; it should
/// generally be propagated rather than handled, at least when implementing formatting traits.
///
/// # Examples /// # Examples
/// ///
/// ``` /// ```