Skip to content

Commit cc8259e

Browse files
committed
Adding more verbose documentation for std::fmt::Write
1 parent 93ab13b commit cc8259e

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

library/core/src/fmt/mod.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,13 @@ pub trait Write {
119119
///
120120
/// This function will return an instance of [`Error`] on error.
121121
///
122+
/// Though it is possible for implementors of this trait to return an error, at the time
123+
/// of writing these docs, no implementation of [`std::fmt::Write`] in the standard library
124+
/// returns such an error.
125+
///
126+
/// When working with external crates, it is advised to check the implementation of this
127+
/// trait and anticipate any possible [`Error`]s.
128+
///
122129
/// # Examples
123130
///
124131
/// ```

0 commit comments

Comments
 (0)