From a8ce6e44ecef10ce38d19b1fd395f1f61dfa5dcc Mon Sep 17 00:00:00 2001 From: David Tolnay Date: Sat, 5 Oct 2019 23:55:33 -0400 Subject: [PATCH] Touch up documentation on Error struct --- src/error.rs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/error.rs b/src/error.rs index 948e834..cae89d2 100644 --- a/src/error.rs +++ b/src/error.rs @@ -11,14 +11,14 @@ use std::backtrace::{Backtrace, BacktraceStatus}; /// The `Error` type, a wrapper around a dynamic error type. /// -/// `Error` functions a lot like `Box`, with these +/// `Error` works a lot like `Box`, but with these /// differences: /// -/// - `Error` requires that the error is `Send`, `Sync`, and `'static` -/// - `Error` guarantees that a backtrace will exist, even if the error type -/// did not provide one -/// - `Error` is represented as a narrow pointer - exactly one word in size, -/// instead of two. +/// - `Error` requires that the error is `Send`, `Sync`, and `'static`. +/// - `Error` guarantees that a backtrace is available, even if the underlying +/// error type does not provide one. +/// - `Error` is represented as a narrow pointer — exactly one word in +/// size instead of two. pub struct Error { inner: Box>, }