Top level documentation missing example for `|`

[gnzlbg]

The top level documentation shows no examples of how to use |.

[BurntSushi]

Could you say more words here? The top-level docs don't really talk about regexes themselves, but instead, just show how to use the API. Are you asking for one of those examples to include the use of |? Otherwise, | is documented in the syntax section below.

(Arguably, this crate should have an "intro to regexes" somewhere, but just haven't had the bandwidth to write it.)

[gnzlbg]

Oh, I missed that. I thought the API docs were also kind of like an intro to regex. Each regex engine that I've used has been subtly similar from all others that I've used to be confusing (this one being no exception), so I don't really think that telling users to look up how to use regexes somewhere else is a good idea.

[BurntSushi]

Any intro to regex tutorial is probably fine. The differences are almost always pretty subtle, and those probably belong in a separate "here are explicit differences" document, not an intro.