]> git.lizzy.rs Git - rust.git/commitdiff
Change std::error::Error trait documentation to talk about `source` instead of `cause`
authorCzipperz <czipperz@gmail.com>
Sat, 29 Dec 2018 07:09:21 +0000 (02:09 -0500)
committerCzipperz <czipperz@gmail.com>
Tue, 8 Jan 2019 22:45:54 +0000 (17:45 -0500)
src/libstd/error.rs

index f026cadd639c318c837ce4dacb3a7e173401af59..2f9efb3f0fb579cfa4677add42daa9f9ce0e60e0 100644 (file)
 /// themselves through the [`Display`] and [`Debug`] traits, and may provide
 /// cause chain information:
 ///
-/// The [`cause`] method is generally used when errors cross "abstraction
-/// boundaries", i.e.,  when a one module must report an error that is "caused"
-/// by an error from a lower-level module. This setup makes it possible for the
-/// high-level module to provide its own errors that do not commit to any
-/// particular implementation, but also reveal some of its implementation for
-/// debugging via [`cause`] chains.
+/// The [`source`] method is generally used when errors cross "abstraction
+/// boundaries". If one module must report an error that is caused by an error
+/// from a lower-level module, it can allow access to that error via the
+/// [`source`] method. This makes it possible for the high-level module to
+/// provide its own errors while also revealing some of the implementation for
+/// debugging via [`source`] chains.
 ///
 /// [`Result<T, E>`]: ../result/enum.Result.html
 /// [`Display`]: ../fmt/trait.Display.html
 /// [`Debug`]: ../fmt/trait.Debug.html
-/// [`cause`]: trait.Error.html#method.cause
+/// [`source`]: trait.Error.html#method.source
 #[stable(feature = "rust1", since = "1.0.0")]
 pub trait Error: Debug + Display {
     /// **This method is soft-deprecated.**