Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Validator] - EmailConstraint reference #3469

Merged
merged 8 commits into from
Apr 2, 2014
Merged

[Validator] - EmailConstraint reference #3469

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
faa034b
[WIP][Valiadtor] - EmailConstraint reference
egulias Jan 12, 2014
e4a0e2f
Use of Sphinx markup
egulias Jan 12, 2014
f0b3b85
Version added and clarifications
egulias Jan 12, 2014
517e4c5
Link moved and heading updated
egulias Jan 12, 2014
aa5aa61
Typo and link label
egulias Jan 12, 2014
a0dd460
Lowercase and link label
egulias Jan 13, 2014
c50f041
CS
egulias Jan 16, 2014
257c483
Blank line restored
egulias Jan 18, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion reference/constraints/Email.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ cast to a string before being validated.
+----------------+---------------------------------------------------------------------+
| Applies to | :ref:`property or method <validation-property-target>` |
+----------------+---------------------------------------------------------------------+
| Options | - `message`_ |
| Options | - `strict`_ |
| | - `message`_ |
| | - `checkMX`_ |
| | - `checkHost`_ |
+----------------+---------------------------------------------------------------------+
Expand Down Expand Up @@ -89,6 +90,15 @@ Basic Usage
Options
-------

strict
~~~~~~~
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the tagline (the line with all those ~ characters) should be even long as the headline (the title). In your case, the tagline is one character longer, which should be removed


**type**: ``boolean`` **default**: ``false``

Will validate the email against a simple RegularExpression.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean: "When false, the email will be validated against a simple Regular Expression" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. As false is the default value I thought it was clear.
Should I change it to be more clear?

If true, then the `EmailValidator <https://packagist.org/packages/egulias/email-validator>`_ library
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

didn't notice this the first time, you should not put the URL inline. Do this: (also not the change of the text)

If true, then the `egulias/email-validator`_ library is required
to perform an RFC compilant validation.

.. at the end of the document
.. _EmailValidator: https://packagist.org/packages/egulias/email-validator

is required to perform an RFC compilant validation.

message
~~~~~~~

Expand Down