about summary refs log tree commit diff
diff options
context:
space:
mode:
authorSteven Allen <steven@stebalien.com>2016-08-23 10:47:28 -0400
committerSteven Allen <steven@stebalien.com>2016-08-23 10:49:11 -0400
commitc7d5f7e5e638775e45c4fdc64f3b91bdbfca9c28 (patch)
treeac70a876867520d93c3311b0cc3b5e90bf1fa1b0
parentf2655e23ff1b377f09cfbb19253a7ea50cd2c4f3 (diff)
Rust has type aliases, not typedefs.
They're the same thing but it's better to keep the terminology consistent.
-rw-r--r--src/libcollections/fmt.rs18
1 files changed, 9 insertions, 9 deletions
diff --git a/src/libcollections/fmt.rs b/src/libcollections/fmt.rs
index a1b4461949c..beb3e6b3d4e 100644
--- a/src/libcollections/fmt.rs
+++ b/src/libcollections/fmt.rs
@@ -165,15 +165,15 @@
 //! provides some helper methods.
 //!
 //! Additionally, the return value of this function is `fmt::Result` which is a
-//! typedef to `Result<(), std::fmt::Error>`. Formatting implementations should
-//! ensure that they propagate errors from the `Formatter` (e.g., when calling
-//! `write!`) however, they should never return errors spuriously. That is, a
-//! formatting implementation must and may only return an error if the passed-in
-//! `Formatter` returns an error. This is because, contrary to what the function
-//! signature might suggest, string formatting is an infallible operation.
-//! This function only returns a result because writing to the underlying stream
-//! might fail and it must provide a way to propagate the fact that an error has
-//! occurred back up the stack.
+//! type alias of `Result<(), std::fmt::Error>`. Formatting implementations
+//! should ensure that they propagate errors from the `Formatter` (e.g., when
+//! calling `write!`) however, they should never return errors spuriously. That
+//! is, a formatting implementation must and may only return an error if the
+//! passed-in `Formatter` returns an error. This is because, contrary to what
+//! the function signature might suggest, string formatting is an infallible
+//! operation. This function only returns a result because writing to the
+//! underlying stream might fail and it must provide a way to propagate the fact
+//! that an error has occurred back up the stack.
 //!
 //! An example of implementing the formatting traits would look
 //! like: