8000 Update Yaml docs to list the features not supported · Issue #6730 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

Update Yaml docs to list the features not supported #6730

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.

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

Closed
javiereguiluz opened this issue Jul 8, 2016 · 2 comments
Closed

Update Yaml docs to list the features not supported #6730

javiereguiluz opened this issue Jul 8, 2016 · 2 comments
Labels
hasPR A Pull Request has already been submitted for this issue. Yaml

Comments

@javiereguiluz
Copy link
Member

The Yaml component purpose is to parse the config files in Symfony apps. We have added some additional features to make it more useful, but we'll never make it spec-compliant.

Let's improve the Yaml docs adding this note about the purpose of the component and let's list the main unsupported features (such as symfony/symfony#12095).

@javiereguiluz
Copy link
Member Author

@xabbuh and @GuilhemN you are our biggest YAML experts. Maybe you can quickly scan the TOC of the YAML 1.2 spec here http://www.yaml.org/spec/1.2/spec.html and tell me the most important features not supported by the YAML component? Then I'll make the necessary changes in the docs. Thanks!

@GuilhemN
Copy link
Contributor
GuilhemN commented Jul 6, 2017
  • Multi documents aren't supported (--- and ... markers in a YAML file).
  • Complex mapping keys (keys beginning with ?) and complex values (beginning with ? too)
  • Non-scalars mapping keys and soon non-string/non-int keys (in 4.0)
  • Tagged values as keys
  • !!set, !!omap, !!pairs, !!set, !!seq, !!bool, !!int, !!merge, !!null, !!timestamp!!value, !!yaml (see http://www.yaml.org/type/)
  • Global tags (TAG directive %TAG ! tag:example.com,2000:app/ and global references to a tag !<tag:example.com,2000:app/foo>)
  • Not having a key in a mapping ({foo, bar} should be parsed as {foo: ~, bar: ~})

@javiereguiluz javiereguiluz added the hasPR A Pull Request has already been submitted for this issue. label Aug 1, 2017
xabbuh added a commit that referenced this issue 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
@xabbuh xabbuh closed this as completed Sep 15, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hasPR A Pull Request has already been submitted for this issue. Yaml
Projects
None yet
Development

No branches or pull requests

3 participants
0