Skip to content

[RFC] Updating the documentation of the Yaml component #6543

Closed
@javiereguiluz

Description

@javiereguiluz

In http://symfony.com/doc/current/components/yaml/introduction.html we explain how to parse and dump using two different methods: Parser/Dump classes and static methods of Yaml class.

I don't like when we have several ways of doing the same thing ... and I like it less when we don't explain their differences or tell the user when to use each alternative.

So I propose the following:

  • Use the static methods to show the basic usage.
  • Explain the object oriented API later in a new section of that article.
  • Add some info about when to use each alternative.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions