Skip to content

Commit c528d81

Browse files
committed
Elaborate README.
1 parent 4772ef3 commit c528d81

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ into suitable invocations of the
1313
[Re library](https://github.com/ocaml/ocaml-re). The patterns are plain
1414
strings of the form accepted by `Re_pcre`, except groups can be bound to
1515
variables using the syntax `(?<var>...)`. The type of `var` will be
16-
`string` if a match is guaranteed, and `string option` if the variable is
17-
bound to an optionally matched group.
16+
`string` if a match is of the groups is guaranteed given a match of the
17+
whole pattern, and `string option` if the variable is bound to or nested
18+
below an optionally matched group.
1819

1920
## Example
2021

@@ -39,3 +40,14 @@ let () = Lwt_main.run begin
3940
Lwt_stream.iter_s check_line (Lwt_io.lines_of_file "/var/log/syslog")
4041
end
4142
```
43+
44+
### Limitations
45+
46+
- The processor is currently new and not well tested. Please break it and
47+
file bug reports.
48+
- Pattern guards are not implemented.
49+
- Optional patterns due to `?`, `*`, and `{0,n}` are detected. If you find
50+
other reasons a `Re_pcre` pattern may opt, please file a bug report.
51+
- Is it feasible to cover any reasonable ground with exhaustiveness checks?
52+
No attempt is currently made, and no warning is issued for a missing
53+
match-all case.

0 commit comments

Comments
 (0)