Skip to content

Commit 9b90184

Browse files
committed
Better document Error::Io
1 parent 59ccbc2 commit 9b90184

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/errors.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ use std::sync::Arc;
1212
/// The error type used by this crate.
1313
#[derive(Clone, Debug)]
1414
pub enum Error {
15-
/// IO error.
15+
/// XML document cannot be read from or written to underlying source.
1616
///
17-
/// `Arc<IoError>` instead of `IoError` since `IoError` is not `Clone`.
17+
/// Contains the reference-counted I/O error to make the error type `Clone`able.
1818
Io(Arc<IoError>),
1919
/// Input decoding error. If [`encoding`] feature is disabled, contains `None`,
2020
/// otherwise contains the UTF-8 decoding error

0 commit comments

Comments
 (0)