[Validator] Add docs for "canonicalize" option at Locale validation constraint
#9248
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
432ed07 to
0761ea9
Compare
Locale validation constraintLocale validation constraint
There was a problem hiding this comment.
Nice! Thanks for this contribution @phansys (and thanks for implementing the feature too). I left some minor comments.
reference/constraints/Locale.rst
Outdated
| **type**: ``boolean`` **default**: ``false`` | ||
|
|
||
| .. versionadded:: 4.1 | ||
| Using this option with value `false` was deprecated in Symfony 4.1 and it will |
There was a problem hiding this comment.
In this versionadded directive, the false and false code have single backticks but the RST format requires double backticks
reference/constraints/Locale.rst
Outdated
| Using this option with value `false` was deprecated in Symfony 4.1 and it will | ||
| throw an exception in Symfony 5.0, use `true` instead. | ||
|
|
||
| If true, then the :phpmethod:`Locale::canonicalize` method will be applied to |
There was a problem hiding this comment.
If true, then the ... -> If true, the ... ?
reference/constraints/Locale.rst
Outdated
| Using this option with value `false` was deprecated in Symfony 4.1 and it will | ||
| throw an exception in Symfony 5.0, use `true` instead. | ||
|
|
||
| If true, then the :phpmethod:`Locale::canonicalize` method will be applied to |
There was a problem hiding this comment.
applied to before... -> applied before...
reference/constraints/Locale.rst
Outdated
| throw an exception in Symfony 5.0, use `true` instead. | ||
|
|
||
| If true, then the :phpmethod:`Locale::canonicalize` method will be applied to | ||
| before checking the validity of the given locale. |
There was a problem hiding this comment.
Let's add a simple example at the end of this phrase for those who don't fully understand what "canonicalize" means or does. Example:
... before checking the validity of the given locale (e.g. ``FR-fr.utf8``
is transformed into ``fr_FR``).|
Your comments were addressed, thank you @javiereguiluz! |
|
Thanks Javier. |
javiereguiluz
added a commit
that referenced
this pull request
Feb 23, 2018
…` validation constraint (phansys, javiereguiluz) This PR was merged into the master branch. Discussion ---------- [Validator] Add docs for "canonicalize" option at `Locale` validation constraint Related to symfony/symfony#22353, symfony/symfony#26075. Closes #7660. Commits ------- 14f10bc Final changes 4c28e1f Minor changes 0cc4ee8 Add docs for "canonicalize" option at `Locale` validation constraint
xabbuh
added a commit
to xabbuh/symfony-docs
that referenced
this pull request
Feb 23, 2018
javiereguiluz
added a commit
that referenced
this pull request
Feb 23, 2018
aaa2000
pushed a commit
to aaa2000/symfony
that referenced
this pull request
Sep 24, 2018
…n constraint without setting "canonicalize" option to `true` (phansys) This PR was merged into the 4.1-dev branch. Discussion ---------- [Validator] Deprecate use of `Locale` validation constraint without setting "canonicalize" option to `true` |Q |A | |--- |--- | |Branch |master | |Bug fix? |no | |New feature? |no | |BC breaks? |no | |Deprecations?|yes | |Tests pass? |yes | |Fixed tickets|symfony#22353 | |License |MIT | |Doc PR |symfony/symfony-docs#9248| See symfony#22353 (comment). Commits ------- 1572540 Deprecate use of `Locale` validation constraint without setting "canonicalize" option to `true`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to symfony/symfony#22353, symfony/symfony#26075.
Closes #7660.