diff options
| author | Mazdak Farrokhzad <twingoow@gmail.com> | 2019-12-24 04:40:00 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-24 04:40:00 +0100 |
| commit | 75b27ef59cd0eb95b50d0cde14b05e0079b3ebe9 (patch) | |
| tree | f7d619542cf99b1d6cf6f0f01e175ca8355995fd | |
| parent | a75968a7829bf140d66f896084c2dfbdcc79cd30 (diff) | |
| parent | 24f3dcfdc741aaab0f1e56127455143912bc9203 (diff) | |
| download | rust-75b27ef59cd0eb95b50d0cde14b05e0079b3ebe9.tar.gz rust-75b27ef59cd0eb95b50d0cde14b05e0079b3ebe9.zip | |
Rollup merge of #67561 - euclio:remove-description, r=jonas-schievink
remove `description` from `Error` impls in docs Since `description` is soft-deprecated, there's no need to show it implemented in these examples.
| -rw-r--r-- | src/libstd/error.rs | 32 | ||||
| -rw-r--r-- | src/libstd/io/error.rs | 4 |
2 files changed, 5 insertions, 31 deletions
diff --git a/src/libstd/error.rs b/src/libstd/error.rs index 18ebd0f1a67..0992e40121a 100644 --- a/src/libstd/error.rs +++ b/src/libstd/error.rs @@ -91,10 +91,6 @@ pub trait Error: Debug + Display { /// } /// /// impl Error for SuperError { - /// fn description(&self) -> &str { - /// "I'm the superhero of errors" - /// } - /// /// fn cause(&self) -> Option<&dyn Error> { /// Some(&self.side) /// } @@ -109,11 +105,7 @@ pub trait Error: Debug + Display { /// } /// } /// - /// impl Error for SuperErrorSideKick { - /// fn description(&self) -> &str { - /// "I'm SuperError side kick" - /// } - /// } + /// impl Error for SuperErrorSideKick {} /// /// fn get_super_error() -> Result<(), SuperError> { /// Err(SuperError { side: SuperErrorSideKick }) @@ -159,10 +151,6 @@ pub trait Error: Debug + Display { /// } /// /// impl Error for SuperError { - /// fn description(&self) -> &str { - /// "I'm the superhero of errors" - /// } - /// /// fn source(&self) -> Option<&(dyn Error + 'static)> { /// Some(&self.side) /// } @@ -177,11 +165,7 @@ pub trait Error: Debug + Display { /// } /// } /// - /// impl Error for SuperErrorSideKick { - /// fn description(&self) -> &str { - /// "I'm SuperError side kick" - /// } - /// } + /// impl Error for SuperErrorSideKick {} /// /// fn get_super_error() -> Result<(), SuperError> { /// Err(SuperError { side: SuperErrorSideKick }) @@ -261,11 +245,7 @@ impl<'a, E: Error + 'a> From<E> for Box<dyn Error + 'a> { /// } /// } /// - /// impl Error for AnError { - /// fn description(&self) -> &str { - /// "Description of an error" - /// } - /// } + /// impl Error for AnError {} /// /// let an_error = AnError; /// assert!(0 == mem::size_of_val(&an_error)); @@ -300,11 +280,7 @@ impl<'a, E: Error + Send + Sync + 'a> From<E> for Box<dyn Error + Send + Sync + /// } /// } /// - /// impl Error for AnError { - /// fn description(&self) -> &str { - /// "Description of an error" - /// } - /// } + /// impl Error for AnError {} /// /// unsafe impl Send for AnError {} /// diff --git a/src/libstd/io/error.rs b/src/libstd/io/error.rs index c20bd3097b2..efe839d1302 100644 --- a/src/libstd/io/error.rs +++ b/src/libstd/io/error.rs @@ -402,9 +402,7 @@ impl Error { /// } /// } /// - /// impl error::Error for MyError { - /// fn description(&self) -> &str { &self.v } - /// } + /// impl error::Error for MyError {} /// /// impl Display for MyError { /// fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |