Skip to content

[Waiting Code Merge] Update reference/configuration/framework.rst for new serializer service #1829

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 6 commits into from
Mar 30, 2013

Conversation

loalf
Copy link

@loalf loalf commented Oct 18, 2012

This PR is related to this one symfony/symfony#5347.

and :class:`Symfony\\Component\\Serializer\\Encoder\\XmlEncoder)
and one normalizer (:class:`Symfony\\Component\\Serializer\\Normalizer\\GetSetMethodNormalizer`).

You can add more normalizers and/or encoders by tagging them as `serializer.encoder` and
Copy link
Member

Choose a reason for hiding this comment

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

You need to use a double backtrick (`) for inline code in RsT, instead of a single backtrick.

Copy link
Author

Choose a reason for hiding this comment

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

This seems to work fine with a single backtick here, https://github.com/symfony/symfony-docs/blob/master/components/serializer.rst

Copy link
Member

Choose a reason for hiding this comment

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

Well, it does work but isn't the way to go. A single backtick is to indicate a link:

Go to the `symfony website<http://symfony.com/>`

And double backtick is for inline code block:

Create a ``Page`` entity...

More information on the Symfony docs: http://symfony.com/doc/master/contributing/documentation/format.html#restructuredtext

@stof
Copy link
Member

stof commented Oct 18, 2012

you also need to update the reference with the new DIC tags

Adding tags to the tag list reference
@loalf
Copy link
Author

loalf commented Oct 21, 2012

Done!

@wouterj
Copy link
Member

wouterj commented Oct 21, 2012

@loalf in respond to your (removed) answer. The part you linked to (adding-links) is about links, not inline code. As I said, links are wrapped in single backtick and because of that inline code is wrapped in double backticks.

By the way, good job! 👍

@loalf
Copy link
Author

loalf commented Oct 21, 2012

That´s why I removed the comment, :). For some reason I thought you were talking about the code a couple of lines before not those. I realized of it after I put my comment. My apologies.

The GetSetMethodNormalizer is not loaded by default
and :class:`Symfony\\Component\\Serializer\\Encoder\\XmlEncoder`)
but none normalizer. The :class:`Symfony\\Component\\Serializer\\Normalizer\\GetSetMethodNormalizer` is broken by design
so you are required to load it under your responsability. You can do creating a new service and tagging it appropiately.

Copy link
Member

Choose a reason for hiding this comment

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

We should probably provide the configuration to enable this service. That would also serve as a generic example.

weaverryan added a commit that referenced this pull request Mar 30, 2013
…tch-1

Also contains tweaks to #1829

Conflicts:
	reference/configuration/framework.rst
weaverryan added a commit that referenced this pull request Mar 30, 2013
@weaverryan weaverryan merged commit 63fae5b into symfony:master Mar 30, 2013
@weaverryan
Copy link
Member

Hi Javier!

This code for this (and now the docs) have been merged in! I did move some things around and created a new cookbook article about this functionality. The tweaks are at sha: 18f4575 and sha: a9c8ed6. If anyone sees any issues, please let me know.

Thanks!

@loalf
Copy link
Author

loalf commented Apr 1, 2013

Hi @weaverryan, thanks for the heads-up. I am quite happy with both, moving some to its dedicated cookbook and your grammar facelift, :). Thanks!

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.

6 participants