From 747dd22098ff987e0c66d798eaace7003a397ad4 Mon Sep 17 00:00:00 2001
From: Dirkjan Ochtman <dirkjan@ochtman.nl>
Date: Mon, 28 Feb 2022 11:38:50 +0100
Subject: [PATCH] Add some minimal documentation

---
 instant-segment/src/lib.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/instant-segment/src/lib.rs b/instant-segment/src/lib.rs
index 911b4a6..0675bda 100644
--- a/instant-segment/src/lib.rs
+++ b/instant-segment/src/lib.rs
@@ -167,6 +167,7 @@ impl<'a> SegmentState<'a> {
     }
 }
 
+/// Search state for a [`Segmenter`]
 #[derive(Clone, Default)]
 pub struct Search {
     candidates: Vec<Candidate>,
@@ -218,6 +219,7 @@ impl<'a> Index<Range<usize>> for Ascii<'a> {
     }
 }
 
+/// Error returned by [`Segmenter::segment`] when given an invalid character
 #[derive(Debug)]
 pub struct InvalidCharacter;