diff options
| author | Erlang/OTP <[email protected]> | 2010-06-03 09:15:50 +0000 |
|---|---|---|
| committer | Erlang/OTP <[email protected]> | 2010-06-03 09:15:50 +0000 |
| commit | a1d19fe9606ec3500d3d44431c11003017f46594 (patch) | |
| tree | f7a7bfd86d8206474d404b5d6e5aa86faa43178f /lib/stdlib/doc/src/re.xml | |
| parent | 6c6ed6c36e41e34cb360fdeca6556eb4efa4d237 (diff) | |
| parent | cb4f969bfc402eee3360b81af7afec5d99e07f1a (diff) | |
| download | otp-a1d19fe9606ec3500d3d44431c11003017f46594.tar.gz otp-a1d19fe9606ec3500d3d44431c11003017f46594.tar.bz2 otp-a1d19fe9606ec3500d3d44431c11003017f46594.zip | |
Merge branch 'pan/otp_8577_re_pattern_doc' into dev
* pan/otp_8577_re_pattern_doc:
Add documentation of what part of a re mp() can be used for guard tests
OTP-8577 Document re_pattern properties
Some properties of a compiled re pattern are defined to allow for guard
tests.
Diffstat (limited to 'lib/stdlib/doc/src/re.xml')
| -rw-r--r-- | lib/stdlib/doc/src/re.xml | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/lib/stdlib/doc/src/re.xml b/lib/stdlib/doc/src/re.xml index 4d2a0e0995..80adc3e347 100644 --- a/lib/stdlib/doc/src/re.xml +++ b/lib/stdlib/doc/src/re.xml @@ -80,7 +80,11 @@ - a unicode_binary is allowed as the tail of the list</code> <code type="none"> - mp() = Opaque datatype containing a compiled regular expression.</code> + mp() = Opaque datatype containing a compiled regular expression. + - The mp() is guaranteed to be a tuple() having the atom + 're_pattern' as it's first element, to allow for matching in + guards. The arity of the tuple() or the content of the other fields + is however not to be trusted.</code> </section> <funcs> <func> |