From a6082b2a2013a38ec78a07a62cd04b535689aff4 Mon Sep 17 00:00:00 2001 From: Araq Date: Sun, 1 Feb 2015 11:57:13 +0100 Subject: [PATCH] slightly better docs for re module --- lib/impure/re.nim | 6 ++++++ 1 file changed, 6 insertions(+) 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) `_ ## C library. This means that your application will depend on the PRCE