about summary refs log tree commit diff
diff options
context:
space:
mode:
authorAlexander Shirokov <vcdevcom@gmail.com>2022-12-02 14:10:45 +0100
committerAlexander Shirokov <shirokovalexs@gmail.com>2023-01-03 12:27:47 +0100
commitc466be040f123289935c1f3a10fa8aba202bfcc8 (patch)
tree132328a1b7e8a0a75688e5b0292ad1ad3eefaaa8
parent442f997f98ac9f16f60ba3a7109f884dbf8d370c (diff)
downloadrust-c466be040f123289935c1f3a10fa8aba202bfcc8.tar.gz
rust-c466be040f123289935c1f3a10fa8aba202bfcc8.zip
Added error documentation for write_fmt
This continuation of work at rust-lang#98861
-rw-r--r--library/core/src/fmt/mod.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/library/core/src/fmt/mod.rs b/library/core/src/fmt/mod.rs
index 51e6a76cea8..fa5073e3304 100644
--- a/library/core/src/fmt/mod.rs
+++ b/library/core/src/fmt/mod.rs
@@ -174,6 +174,11 @@ pub trait Write {
     /// This method should generally not be invoked manually, but rather through
     /// the [`write!`] macro itself.
     ///
+    /// # Errors
+    ///
+    /// This function will return an instance of [`Error`] on error. Please see
+    /// [write_str](Write::write_str) for details.
+    ///
     /// # Examples
     ///
     /// ```