Explained the explicit typing in YAML documents #8200
Closed
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
xabbuh
reviewed
Jul 20, 2017
components/yaml/yaml_format.rst
Outdated
| @@ -300,4 +300,25 @@ Comments can be added in YAML by prefixing them with a hash mark (``#``): | |||
| Comments are simply ignored by the YAML parser and do not need to be | |||
| indented according to the current level of nesting in a collection. | |||
|
|
|||
| Explicity Typing | |||
xabbuh
reviewed
Jul 20, 2017
components/yaml/yaml_format.rst
Outdated
| Explicity Typing | ||
| ---------------- | ||
|
|
||
| The YAML specification defines some tags to set the type of any data explicitly: |
xabbuh
reviewed
Jul 20, 2017
components/yaml/yaml_format.rst
Outdated
|
|
||
| data: | ||
| # this value is parsed as a string (it's not transformed into a DateTime) | ||
| start_date: !str 2002-12-14 |
There was a problem hiding this comment.
Actually, using the !str tag is not valid YAML. I wonder if we should add support for !!str in Symfony 2.7 as a bugfix.
There was a problem hiding this comment.
I've created this issue: symfony/symfony#23607
There was a problem hiding this comment.
Issue closed. So let's keep it as is.
There was a problem hiding this comment.
I am still reluctant to document invalid YAML. I suggest to just remove it here and only document the !!str in the 3.4 docs.
There was a problem hiding this comment.
I agree with @xabbuh. !str is "a Symfony thing" and it's wrong. Let's pretend it doesn't exist 😁
HeahDude
approved these changes
Jul 29, 2017
components/yaml/yaml_format.rst
Outdated
|
|
||
| data: | ||
| # this value is parsed as a string (it's not transformed into a DateTime) | ||
| start_date: !str 2002-12-14 |
There was a problem hiding this comment.
Issue closed. So let's keep it as is.
xabbuh
approved these changes
Jul 31, 2017
|
Thank you Javier. |
xabbuh
added a commit
that referenced
this pull request
Aug 1, 2017
…uiluz) This PR was squashed before being merged into the 2.7 branch (closes #8200). Discussion ---------- Explained the explicit typing in YAML documents I was going to fix #8173 but I couldn't find the explicit typing explanation anywhere, so I include it here. ----- When merging this into 3.4, the `!str` tag must be changed by `!!tag` and we must add this: ``` .. versionadded:: 3.4 The support of ``!!str`` tag was introduced in Symfony 3.4. In previous versions you needed to use the ``!str`` tag. ``` Commits ------- aa1b968 Explained the explicit typing in YAML documents
xabbuh
added a commit
that referenced
this pull request
Aug 1, 2017
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.
I was going to fix #8173 but I couldn't find the explicit typing explanation anywhere, so I include it here.
When merging this into 3.4, the
!strtag must be changed by!!tagand we must add this: