From cb4f969bfc402eee3360b81af7afec5d99e07f1a Mon Sep 17 00:00:00 2001
From: Patrik Nyblom <pan@erlang.org>
Date: Wed, 2 Jun 2010 09:19:42 +0200
Subject: Add documentation of what part of a re mp() can be used for guard
 tests

---
 lib/stdlib/doc/src/re.xml | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

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>
-- 
cgit v1.2.3