diff options
| author | Erik Terpstra <erterpstra@gmail.com> | 2020-06-25 15:20:23 +0200 |
|---|---|---|
| committer | Louis Pilfold <louis@lpil.uk> | 2020-06-25 14:31:57 +0100 |
| commit | 8dab27e6cd093c509e2ca0379dfd41524edc17dc (patch) | |
| tree | f5089449900c082a3be3be85c4bc7923ba908531 | |
| parent | 8de363f9d7ddd3df55df73b27a3a87cf7c9bd707 (diff) | |
| download | gleam_stdlib-8dab27e6cd093c509e2ca0379dfd41524edc17dc.tar.gz gleam_stdlib-8dab27e6cd093c509e2ca0379dfd41524edc17dc.zip | |
Change index to byte index in doc comments
| -rw-r--r-- | src/gleam/regex.gleam | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/gleam/regex.gleam b/src/gleam/regex.gleam index 6534095..5c668eb 100644 --- a/src/gleam/regex.gleam +++ b/src/gleam/regex.gleam @@ -10,7 +10,7 @@ pub external type Regex /// The details about a particular match: /// /// - match — the full string of the match. -/// - index — the index of the match in the original string. +/// - index — the byte index of the match in the original string. /// - submatches — a Regex can have subpatterns, sup-parts that are in parentheses. /// pub type Match { @@ -20,7 +20,7 @@ pub type Match { /// When a regular expression fails to compile: /// /// - error — a descriptive error message -/// - index — the index of the cause in the regex string +/// - index — the byte index of the cause in the regex string /// pub type FromStringError { FromStringError(error: String, index: Int) |