Improve doc comments on error variants

This commit is contained in:
Tobie Morgan Hitchcock 2022-05-04 12:41:34 +01:00
parent 896e384b98
commit 5182359813

View file

@ -227,11 +227,11 @@ pub enum Error {
#[error("Serde error: {0}")] #[error("Serde error: {0}")]
Serde(#[from] SerdeError), Serde(#[from] SerdeError),
/// Represents an underlying error from the EchoDB instance /// Represents an error when encoding a key-value entry
#[error("Key encoding error: {0}")] #[error("Key encoding error: {0}")]
Encode(#[from] EncodeError), Encode(#[from] EncodeError),
/// Represents an underlying error from the EchoDB instance /// Represents an error when decoding a key-value entry
#[error("Key decoding error: {0}")] #[error("Key decoding error: {0}")]
Decode(#[from] DecodeError), Decode(#[from] DecodeError),