From 4c7156b1873e2cdb6ddbe5c3a68e6f08f0ad1032 Mon Sep 17 00:00:00 2001
From: Jimmy Cuadra <jimmy@jimmycuadra.com>
Date: Tue, 23 Jul 2019 00:26:35 -0700
Subject: [PATCH] Clarify when `FromStrErr` is used.

---
 src/lib.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index bb826671..18288f00 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -231,6 +231,9 @@ impl Display for InvalidInput {
 impl Error for InvalidInput {}
 
 /// An error when attempting to create a value from a string via the `FromStr` trait.
+///
+/// This error type is only used for simple enums with unit variants. Event deserialization through
+/// the `FromStr` trait returns an `InvalidEvent` on error.
 #[derive(Clone, Copy, Eq, Debug, Hash, PartialEq)]
 pub struct FromStrError;