[Validator] - EmailConstraint reference#3469
Conversation
reference/constraints/Email.rst
Outdated
There was a problem hiding this comment.
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
|
You documented it right the correct way: Saying what will happen and what is required for it to work I see no other problems with this PR, except that you need to add a |
reference/constraints/Email.rst
Outdated
There was a problem hiding this comment.
this should be placed before the headline. So you get something like:
.. versionadded:: 2.5
The ``strict`` option was introduced in Symfony 2.5.
strict
reference/constraints/Email.rst
Outdated
reference/constraints/Email.rst
Outdated
There was a problem hiding this comment.
I'm sorry, but you have to change another thing (I really hope it's the last change ;-) ), you should add a line break after the first word that crosses the 72th character.
|
Thank you! I hope now is correct :) |
reference/constraints/Email.rst
Outdated
There was a problem hiding this comment.
Sorry, I meant only to remove one of the two blank lines. So, one blank line should be preserved.
There was a problem hiding this comment.
My bad too, I should have thought a little :)
…ncy (egulias) This PR was squashed before being merged into the 2.5-dev branch (closes #9140). Discussion ---------- [Validator][Email] - Strict validation and soft dependency | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | yes | Deprecations? | no | Tests pass? | yes | Fixed tickets | #1581, #4930 | License | MIT | Doc PR | symfony/symfony-docs#3469 TODO --------- - [x] submit changes to the documentation - [x] document the BC breaks - [x] finish the code - [x] gather feedback for my changes In #1581 @bschussek suggested to pass the strict_email config to `Validator\EmailValidator::__construct($strict)`, I did not put it there yet since the constraint can receive that configuration each time the constraint is used despite the fact of the global configuration. This could lead to some logic in the constructor and I wanted first to integrate the strict validator. BC Break -------------- I'm not sure of this, but as a soft dependency is added and now some emails that where valid before no longer are I thought it is. Commits ------- 3368630 #1581 - Strict in Email constraint and use of Egulias\EmailValidator
|
Hi @wouterj the PR has been merged so I guess this can be merged too. Let me know any issues. |
|
👍 Thanks for all the work you spent on this topic, @egulias! |
|
😄 |
|
Nice feature and thanks for your work getting this PR absolutely perfect. Cheers Eduardo! |
This PR was merged into the master branch. Discussion ---------- [Validator] - EmailConstraint reference | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes - symfony/symfony#9140 | Applies to | master | Fixed tickets | Note ------ I'm not sure if this behaviour change should go in a page by itself (like https://github.com/symfony/symfony-docs/blob/2.4/components/dependency_injection/lazy_services.rst) since requires the installation of an external library to work. I appreciate some guide on this since it's my first doc PR, thanks. Commits ------- 257c483 Blank line restored c50f041 CS a0dd460 Lowercase and link label aa5aa61 Typo and link label 517e4c5 Link moved and heading updated f0b3b85 Version added and clarifications e4a0e2f Use of Sphinx markup faa034b [WIP][Valiadtor] - EmailConstraint reference
Note
I'm not sure if this behaviour change should go in a page by itself (like https://github.com/symfony/symfony-docs/blob/2.4/components/dependency_injection/lazy_services.rst) since requires the installation of an external library to work.
I appreciate some guide on this since it's my first doc PR, thanks.