From 98e8536fa4f955c57ad1e577ef013793e4306897 Mon Sep 17 00:00:00 2001 From: Andrew Date: Sat, 17 Feb 2018 14:36:03 +0000 Subject: [PATCH] Docs: clarify behavior of `UWordBoundIndices` Briefly document the iterator behavior of `UWordBoundIndices` on the struct itself. --- src/word.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/word.rs b/src/word.rs index 436582c..31920fe 100644 --- a/src/word.rs +++ b/src/word.rs @@ -44,6 +44,9 @@ pub struct UWordBounds<'a> { } /// External iterator for word boundaries and byte offsets. +/// +/// Yields `(usize, &str)` pairs carrying string slices delimited by word +/// boundaries and their positions. #[derive(Clone)] pub struct UWordBoundIndices<'a> { start_offset: usize,