Skip to content

Added a note about the lacking features of Yaml Component #4208

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

Merged
merged 1 commit into from
Sep 15, 2014
Merged

Added a note about the lacking features of Yaml Component #4208

merged 1 commit into from
Sep 15, 2014

Conversation

javiereguiluz
Copy link
Member

Q A
Doc fix? no
New docs? yes
Applies to 2.3+
Fixed tickets -

In symfony/symfony repository there are a lot of issues reporting errors of the Yaml Component. These aren't errors but lacking features of the Yaml Component.

This PR tries to clearly state that Yaml Component lacks lots of features on purpose and provides a simple list of the most notable missing features.

One of the goals of Symfony Yaml is to find the right balance between speed and
features. It supports just the needed features to handle configuration files.
Notable lacking features are: document directives, multi-line quoted messages,
compact block collections and multi-document files.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think multi-line quoted messages and compact block collections could be fixed easily. I'll have a look at both issues. For the rest, I think we can improve the user experience a lot if we provide more sensible exception messages like the one I mentioned in symfony/symfony#8076.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree! But for now, we could add this note to prevent misunderstandings when using this component.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with you. We can update it whenever something changes in the code.

@xabbuh
Copy link
Member

xabbuh commented Sep 15, 2014

@javiereguiluz This needs a rebase.

@weaverryan
Copy link
Member

@xabbuh It's no problem - in this case I was able to resolve them. It's mostly a problem when we need to change branches and there's a conflict. Thanks Javier for this!

@weaverryan weaverryan merged commit fe45194 into symfony:2.3 Sep 15, 2014
weaverryan added a commit that referenced this pull request Sep 15, 2014
… (javiereguiluz)

This PR was merged into the 2.3 branch.

Discussion
----------

Added a note about the lacking features of Yaml Component

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes
| Applies to    | 2.3+
| Fixed tickets | -

In `symfony/symfony` repository there are a lot of issues reporting errors of the Yaml Component. These aren't errors but lacking features of the Yaml Component.

This PR tries to clearly state that Yaml Component lacks lots of features on purpose and provides a simple list of the most notable missing features.

Commits
-------

fe45194 Added a note about the lacking features of Yaml Component
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants