aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBobby <[email protected]>2022-10-06 18:03:33 -0400
committerGitHub <[email protected]>2022-10-06 18:03:33 -0400
commit155f2499d15bab010e79b24f96d77758a87b7bbc (patch)
treee692b928723543292abbc1b86ea7b64e5553430f
parent79c48741a13c6919a4c5b41df4c83e7275df6b94 (diff)
parentd0e9a72ddda41ccbce20959d36e4a59b56aa71e0 (diff)
downloadedify-155f2499d15bab010e79b24f96d77758a87b7bbc.tar.xz
edify-155f2499d15bab010e79b24f96d77758a87b7bbc.zip
Add warning for trade-offs in email regex validation (#18)
Fixes #8
-rw-r--r--docs/built-in/index.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/built-in/index.rst b/docs/built-in/index.rst
index c14923b..f79571d 100644
--- a/docs/built-in/index.rst
+++ b/docs/built-in/index.rst
@@ -10,7 +10,7 @@ The ``email`` function verifies that a string is a valid email address. The func
.. warning::
- The ``email`` function is not a complete email address validator. It only checks that the string is in the correct format. It does not check that the domain name is valid or that the email address actually exists.
+ The ``email`` function is not a complete email address validator. It only checks that the string is in the correct format. It does not check that the domain name is valid or that the email address actually exists. This shall also be noted that there are certain trade-offs while validating email addresses using regular expressions. Regular expressions do not serve as a robust solution and should be avoided while validating complex email addresses. To learn more, go to `regular-expressions.info/email.html <https://www.regular-expressions.info/email.html>`_.
To use the ``email`` function, import it from the ``edify.library`` module.