summary refs log tree commit diff stats
path: root/lib/impure/re.nim
diff options
context:
space:
mode:
authorAraq <rumpf_a@web.de>2015-02-01 11:57:13 +0100
committerAraq <rumpf_a@web.de>2015-02-01 11:58:40 +0100
commita6082b2a2013a38ec78a07a62cd04b535689aff4 (patch)
tree37340ade61b2e0fc3d5bd0e43e348161eba42d4b /lib/impure/re.nim
parent9bd72fc0d96c1ce2e0c162b446346ec0e39712e2 (diff)
downloadNim-a6082b2a2013a38ec78a07a62cd04b535689aff4.tar.gz
slightly better docs for re module
Diffstat (limited to 'lib/impure/re.nim')
-rw-r--r--lib/impure/re.nim6
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/impure/re.nim b/lib/impure/re.nim
index a7bebb81c..7d5ff8948 100644
--- a/lib/impure/re.nim
+++ b/lib/impure/re.nim
@@ -9,6 +9,12 @@
 
 ## Regular expression support for Nim. Consider using the pegs module
 ## instead.
+##
+## **Note:** The 're' proc defaults to the **extended regular expression
+## syntax** which lets you use whitespace freely to make your regexes readable.
+## However, this means to match whitespace ``\s`` or something similar has
+## to be used.
+##
 ## This module is implemented by providing a wrapper around the
 ## `PRCE (Perl-Compatible Regular Expressions) <http://www.pcre.org>`_
 ## C library. This means that your application will depend on the PRCE