Mention the YAML features not supported by the Yaml component #8249
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
approved these changes
Aug 4, 2017
GuilhemN
reviewed
Aug 9, 2017
components/yaml/yaml_format.rst
Outdated
| @@ -171,8 +166,8 @@ Collections | |||
| ----------- | |||
|
|
|||
| A YAML file is rarely used to describe a simple scalar. Most of the time, it | |||
| describes a collection. A collection can be a sequence or a mapping of | |||
| elements. Both sequences and mappings are converted to PHP arrays. | |||
| describes a collection. YAML collections can be a sequence (scalar arrays in PHP) | |||
There was a problem hiding this comment.
Not sure what you mean by scalar arrays. Perhaps numerically-indexed arrays would be better?
components/yaml/yaml_format.rst
Outdated
| describes a collection. A collection can be a sequence or a mapping of | ||
| elements. Both sequences and mappings are converted to PHP arrays. | ||
| describes a collection. YAML collections can be a sequence (scalar arrays in PHP) | ||
| or a mapping of elements (key/value arrays in PHP). |
components/yaml/yaml_format.rst
Outdated
| `!!bool`, `!!int`, `!!merge`, `!!null`, `!!timestamp`, `!!value`, `!!yaml`; | ||
| * Global tags (``TAG`` directive; example: ``%TAG ! tag:example.com,2000:app/``) | ||
| and global references to a tag (example: ``!<tag:example.com,2000:app/foo>``); | ||
| * Not having a key in a mapping (example: ``{foo, bar}``; use |
There was a problem hiding this comment.
What about Using sequence-like syntax for mapping elements?
components/yaml/yaml_format.rst
Outdated
| * Tagged values as keys; | ||
| * The following tags and types: `!!set`, `!!omap`, `!!pairs`, `!!set`, `!!seq`, | ||
| `!!bool`, `!!int`, `!!merge`, `!!null`, `!!timestamp`, `!!value`, `!!yaml`; | ||
| * Global tags (``TAG`` directive; example: ``%TAG ! tag:example.com,2000:app/``) |
There was a problem hiding this comment.
I'd remove globals tags and just keep TAG directive
components/yaml/yaml_format.rst
Outdated
| * The following tags and types: `!!set`, `!!omap`, `!!pairs`, `!!set`, `!!seq`, | ||
| `!!bool`, `!!int`, `!!merge`, `!!null`, `!!timestamp`, `!!value`, `!!yaml`; | ||
| * Global tags (``TAG`` directive; example: ``%TAG ! tag:example.com,2000:app/``) | ||
| and global references to a tag (example: ``!<tag:example.com,2000:app/foo>``); |
There was a problem hiding this comment.
global doesn't feel like the right term... Maybe something like uri-named tags?
components/yaml/yaml_format.rst
Outdated
|
|
||
| The following YAML features are not supported by the Symfony Yaml component: | ||
|
|
||
| * Structures and multi-documents (``---`` and ``...`` markers); |
There was a problem hiding this comment.
What do you mean by structures?
|
I've fixed all the reported issues. @GuilhemN thanks for your review. |
xabbuh
reviewed
Sep 7, 2017
components/yaml/yaml_format.rst
Outdated
| * Tagged values as keys; | ||
| * The following tags and types: `!!set`, `!!omap`, `!!pairs`, `!!set`, `!!seq`, | ||
| `!!bool`, `!!int`, `!!merge`, `!!null`, `!!timestamp`, `!!value`, `!!yaml`; | ||
| * Tags (``TAG`` directive; example: ``%TAG ! tag:example.com,2000:app/``) |
There was a problem hiding this comment.
one of the spaces needs to be removed between the asterisk and "Tags"
|
Thank you @javiereguiluz. |
xabbuh
added a commit
that referenced
this pull request
Sep 15, 2017
…nent (javiereguiluz) This PR was squashed before being merged into the 2.7 branch (closes #8249). Discussion ---------- Mention the YAML features not supported by the Yaml component This fixes #6730 thanks to [this comment](#6730 (comment)) from @GuilhemN. Commits ------- eeaeac1 Mention the YAML features not supported by the Yaml component
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.
This fixes #6730 thanks to this comment from @GuilhemN.