[Turbo] Minor documentation syntax fixes #2692
Conversation
src/Turbo/doc/index.rst
Outdated
| **must** contain at least 3 blocks: ``create``, ``update`` and | ||
| ``remove`` (they can be empty, but they must exist). | ||
| ``templates/broadcast/{ClassName}.stream.html.twig``. This template can contain 3 blocks: ``create`` block for entity creation. ``update`` block for entity update. ``remove`` block for entity deletion. |
There was a problem hiding this comment.
I don't know when it changed but I only tested with the create block in my template and I didn't encounter any errors.
There was a problem hiding this comment.
Even during an update and a remove broadcast (just to b 10000 e sure) ?
There was a problem hiding this comment.
Exactly, it also works for update and remove.
There was a problem hiding this comment.
And of course, they are mandatory when creating, deleting or updating, otherwise an error is returned.
There was a problem hiding this comment.
Wait so they "can" or they "must" ?
There was a problem hiding this comment.
create block must be present if it's a creation.
update block must be present if it's an update.
remove block must be present if it's a deletion.
For example, for my Book entity, I need to render a template on creation and update. I should have the following code:
{# templates/broadcast/Book.stream.html.twig #}
{% block create %}
[...]
{% endblock %}
{% block update %}
[...]
{% endblock %}The remove block isn't present, and it works.
With the current documentation, the developer will think it's necessary to do this:
{# templates/broadcast/Book.stream.html.twig #}
{% block create %}
[...]
{% endblock %}
{% block update %}
[...]
{% endblock %}
{% block remove %}
{% endblock %}With an empty remove block, but this isn't necessary.
There was a problem hiding this comment.
I'm not sure i agree with this way of presenting thing. Their entity can be deleted or updated. If this happens and they did not put these blocks here, their app will crash.
I'd say we need either a way to explain it very clearly, or let's keep the current formulation.
WDYT ?
There was a problem hiding this comment.
Yeah ok, let's keep the current formulation then :).
|
Thank you @seb-jean. |
Fixed documentation regarding blocks when using broadcast. Blocks are not required.