diff options
| author | Patrik Nyblom <[email protected]> | 2010-06-02 09:19:42 +0200 |
|---|---|---|
| committer | Patrik Nyblom <[email protected]> | 2010-06-02 09:25:03 +0200 |
| commit | cb4f969bfc402eee3360b81af7afec5d99e07f1a (patch) | |
| tree | d1cead3245f63d12be7cae7ca8a75d8213d9dcf8 /lib/stdlib/doc | |
| parent | 012e340d83e34200705200c5fafd55ee990c1795 (diff) | |
| download | otp-cb4f969bfc402eee3360b81af7afec5d99e07f1a.tar.gz otp-cb4f969bfc402eee3360b81af7afec5d99e07f1a.tar.bz2 otp-cb4f969bfc402eee3360b81af7afec5d99e07f1a.zip | |
Add documentation of what part of a re mp() can be used for guard tests
Diffstat (limited to 'lib/stdlib/doc')
| -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> |