Document GraphemeCursor a bit more

Manishearth · Manishearth · commit c70eef5075ce · 2021-07-10T08:18:20.000-07:00
diff --git a/src/grapheme.rs b/src/grapheme.rs
@@ -165,6 +165,9 @@ enum GraphemeState {
 }
 
 /// Cursor-based segmenter for grapheme clusters.
+///
+/// This allows working with ropes and other datastructures where the string is not contiguous or
+/// fully known at initialization time.
 #[derive(Clone, Debug)]
 pub struct GraphemeCursor {
     // Current cursor position.

Original file line number	Diff line number	Diff line change
`@@ -165,6 +165,9 @@ enum GraphemeState {`
`165`	`165`	`}`
`166`	`166`
`167`	`167`	`/// Cursor-based segmenter for grapheme clusters.`
	`168`	`+///`
	`169`	`+/// This allows working with ropes and other datastructures where the string is not contiguous or`
	`170`	`+/// fully known at initialization time.`
`168`	`171`	`#[derive(Clone, Debug)]`
`169`	`172`	`pub struct GraphemeCursor {`
`170`	`173`	`// Current cursor position.`