Better document Error::Io

tafia · Sep 29, 2023 · 9b90184 · 9b90184
1 parent 59ccbc2
commit 9b90184
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/errors.rs b/src/errors.rs
@@ -12,9 +12,9 @@ use std::sync::Arc;
 /// The error type used by this crate.
 #[derive(Clone, Debug)]
 pub enum Error {
-    /// IO error.
+    /// XML document cannot be read from or written to underlying source.
     ///
-    /// `Arc<IoError>` instead of `IoError` since `IoError` is not `Clone`.
+    /// Contains the reference-counted I/O error to make the error type `Clone`able.
     Io(Arc<IoError>),
     /// Input decoding error. If [`encoding`] feature is disabled, contains `None`,
     /// otherwise contains the UTF-8 decoding error