Change std::error::Error trait documentation to talk about source instead of cause

This commit is contained in:
Czipperz
2018-12-29 02:09:21 -05:00
parent 6ecad33838
commit 564a24c772

View File

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