From 8c8f1790f193c225e691ae89c69c3aba79fa1595 Mon Sep 17 00:00:00 2001 From: Jimmy Cuadra Date: Mon, 8 Jul 2019 03:55:12 -0700 Subject: [PATCH] Clarify how InvalidInput differs from InvalidEvent. --- src/lib.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 9388260e..e614c7f3 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -206,6 +206,9 @@ impl From for InvalidEvent { } /// An error returned when attempting to create an event with data that would make it invalid. +/// +/// This type is similar to `InvalidEvent`, but used during the construction of a new event, as +/// opposed to deserialization of an existing event from JSON. #[derive(Clone, Debug, PartialEq)] pub struct InvalidInput(String);