Skip to content

Update yaml component docs for 2.3 Yaml::parse(filename) deprecation #2620

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
wants to merge 1 commit into from

Conversation

jbafford
Copy link
Contributor

@jbafford jbafford commented May 8, 2013

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

Using a filename as argument to Yaml::parse is deprecated as of 2.3 and will be removed from sf 3.0. Updated the documentation to indicate this, and include the warning from the source about the need to validate the input first.

…cation

Using a filename as argument to Yaml::parse is deprecated as of 2.3 and will be removed from sf 3.0. Updated the documentation to indicate this, and include the warning from the source about the need to validate the input first.

The :method:`Symfony\\Component\\Yaml\\Yaml::parse` static method takes a YAML
string or a file containing YAML. Internally, it calls the
:method:`Symfony\\Component\\Yaml\\Parser::parse` method, but enhances the
error if something goes wrong by adding the filename to the message.

.. note::
Copy link
Member

Choose a reason for hiding this comment

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

I suggest a .. caution:: directive

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants