Skip to content
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

Updated the docs for the new way to render partials/ESI/HInclude #2121

Merged
merged 3 commits into from Jan 13, 2013

Conversation

fabpot
Copy link
Member

@fabpot fabpot commented Jan 12, 2013

This is probably just a first step as I think that the new content rendering mechanism can probably be documented in one centralized place where all options are documented.

see symfony/symfony#6459

+----------------------------------------------------+--------------------------------------------------------------------------------------------+
| ``render_hinclude(controller('B:C:a', {params}))`` | This will generates an Hinclude tag for the given controller or URL. |
| ``render_hinclude(url('route', {params}))`` | For more information, see :ref:`templating-embedding-controller`. |
| ``render_hinclude(path('route', {params}))`` | |
Copy link
Member

Choose a reason for hiding this comment

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

you should document the function only, with its signature, so that people can see their name to use named arguments IMO.

Copy link
Member

Choose a reason for hiding this comment

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

@stof just to learn something, we should we display the correct parameter name for named arguments here, but not in #2092?

Copy link
Member

Choose a reason for hiding this comment

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

@wouterj the way the form functions are implemented means that the named arguments don't work with them (they are using custom nodes, so they would have to implement the support in these nodes). On the other hand, these functions are using the Twig built-in nodes, so they support named argument.
So for forms, using the right argument is impossible (as there is not even such names as it does not map directly to a function but processes the arguments IIRC) whereas it adds some value here

weaverryan added a commit that referenced this pull request Jan 13, 2013
Updated the docs for the new way to render partials/ESI/HInclude
@weaverryan weaverryan merged commit 823cef3 into symfony:master Jan 13, 2013
weaverryan added a commit that referenced this pull request Jan 13, 2013
@weaverryan
Copy link
Member

Hi guys!

I've merged this in - @fabpot did a really good job catching all the changes - I double-checked things to be sure. So, I think the existing documentation is in good shape from an accuracy standpoint. I've also added #2129 about documenting the content rendering system in more detail.

If anyone spots any other missing spots or error in my commit, please let me know!

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.

None yet

4 participants