docs: document that Label::new expects char offsets

zesterer · Aug 30, 2023 · 9bead87 · 9bead87
1 parent e9e1c43
commit 9bead87
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -80,6 +80,7 @@ pub struct Label<S = Range<usize>> {
 
 impl<S> Label<S> {
     /// Create a new [`Label`].
+    /// If the span is specified as a `Range<usize>` the numbers have to be zero-indexed character offsets.
     pub fn new(span: S) -> Self {
         Self {
             span,