minor #1601 [Twig] Update the doc blocks (rosier)

javiereguiluz · javiereguiluz · commit e28fadcbd642 · 2025-09-05T13:19:26.000+02:00
This PR was merged into the main branch. Discussion ---------- [Twig] Update the doc blocks This makes the formatting of the doc blocks a bit more consistent Commits ------- 2f268df Update twig doc blocks
diff --git a/templates/admin/blog/index.html.twig b/templates/admin/blog/index.html.twig
@@ -17,9 +17,11 @@
         {% for post in posts %}
             <tr>
                 <td>{{ post.title }}</td>
-                {# it's not mandatory to set the timezone in localizeddate(). This is done to
-                   avoid errors when the 'intl' PHP extension is not available and the application
-                   is forced to use the limited "intl polyfill", which only supports UTC and GMT #}
+                {#
+                    It's not mandatory to set the timezone in format_datetime(). This is done to
+                    avoid errors when the 'intl' PHP extension is not available and the application
+                    is forced to use the limited "intl polyfill", which only supports UTC and GMT
+                #}
                 <td>{{ post.publishedAt|format_datetime('medium', 'short', '', 'UTC') }}</td>
                 <td class="text-right">
                     <div class="item-actions">
diff --git a/templates/admin/layout.html.twig b/templates/admin/layout.html.twig
@@ -1,9 +1,9 @@
 {#
-   This is the base template of the all backend pages. Since this layout is similar
-   to the global layout, we inherit from it to just change the contents of some
-   blocks. In practice, backend templates are using a three-level inheritance,
-   showing how powerful, yet easy to use, is Twig's inheritance mechanism.
-   See https://symfony.com/doc/current/templates.html#template-inheritance-and-layouts
+    This is the base template of the all backend pages. Since this layout is similar
+    to the global layout, we inherit from it to just change the contents of some
+    blocks. In practice, backend templates are using a three-level inheritance,
+    showing how powerful, yet easy to use, is Twig's inheritance mechanism.
+    See https://symfony.com/doc/current/templates.html#template-inheritance-and-layouts
 #}
 {% extends 'base.html.twig' %}
 
diff --git a/templates/base.html.twig b/templates/base.html.twig
@@ -1,7 +1,7 @@
 {#
-   This is the base template used as the application layout which contains the
-   common elements and decorates all the other templates.
-   See https://symfony.com/doc/current/templates.html#template-inheritance-and-layouts
+    This is the base template used as the application layout which contains the
+    common elements and decorates all the other templates.
+    See https://symfony.com/doc/current/templates.html#template-inheritance-and-layouts
 #}
 <!DOCTYPE html>
 <html lang="{{ app.locale }}" dir="{{ is_rtl() ? 'rtl' : 'ltr' }}">
@@ -132,9 +132,11 @@
             </footer>
         {% endblock %}
 
-        {# it's not mandatory to set the timezone in localizeddate(). This is done to
-           avoid errors when the 'intl' PHP extension is not available and the application
-           is forced to use the limited "intl polyfill", which only supports UTC and GMT #}
+        {#
+            It's not mandatory to set the timezone in format_datetime(). This is done to
+            avoid errors when the 'intl' PHP extension is not available and the application
+            is forced to use the limited "intl polyfill", which only supports UTC and GMT
+        #}
         <!-- Page rendered on {{ 'now'|format_datetime('long', 'long', '', 'UTC') }} -->
     </body>
 </html>
diff --git a/templates/blog/_comment_form.html.twig b/templates/blog/_comment_form.html.twig
@@ -7,7 +7,8 @@
 #}
 
 {{ form_start(form, {method: 'POST', action: path('comment_new', {'postSlug': post.slug})}) }}
-    {#  instead of displaying form fields one by one, you can also display them
+    {#
+        Instead of displaying form fields one by one, you can also display them
         all with their default options and styles just by calling to this function:
 
         {{ form_widget(form) }}
diff --git a/templates/blog/about.html.twig b/templates/blog/about.html.twig
@@ -9,7 +9,9 @@
     </div>
 </div>
 
-{# it's not mandatory to set the timezone in localizeddate(). This is done to
-   avoid errors when the 'intl' PHP extension is not available and the application
-   is forced to use the limited "intl polyfill", which only supports UTC and GMT #}
+{#
+    It's not mandatory to set the timezone in format_datetime(). This is done to
+    avoid errors when the 'intl' PHP extension is not available and the application
+    is forced to use the limited "intl polyfill", which only supports UTC and GMT
+#}
 <!-- Fragment rendered on {{ 'now'|format_datetime('long', 'long', '', 'UTC') }} -->
diff --git a/templates/blog/post_show.html.twig b/templates/blog/post_show.html.twig
@@ -15,15 +15,18 @@
     {{ include('blog/_post_tags.html.twig') }}
 
     <div id="post-add-comment" class="well">
-        {# The 'IS_AUTHENTICATED_FULLY' role ensures that the user has entered
-        their credentials (login + password) during this session. If they
-        are automatically logged via the 'Remember Me' functionality, they won't
-        be able to add a comment.
-        See https://symfony.com/doc/current/security/remember_me.html#forcing-the-user-to-re-authenticate-before-accessing-certain-resources
+        {#
+            The 'IS_AUTHENTICATED_FULLY' role ensures that the user has entered
+            their credentials (login + password) during this session. If they
+            are automatically logged via the 'Remember Me' functionality, they won't
+            be able to add a comment.
+            See https://symfony.com/doc/current/security/remember_me.html#forcing-the-user-to-re-authenticate-before-accessing-certain-resources
         #}
         {% if is_granted('IS_AUTHENTICATED_FULLY') %}
-            {# when the name of the Twig argument is the same as the name of the variable, you can omit it.
-               e.g. instead of controller('...', {post: post}) you can use controller('...', {post}) #}
+            {#
+                When the name of the Twig argument is the same as the name of the variable, you can omit it.
+                e.g. instead of controller('...', {post: post}) you can use controller('...', {post})
+            #}
             {{ render(controller('App\\Controller\\BlogController::commentForm', {post})) }}
         {% else %}
             <p>
@@ -44,9 +47,11 @@
             <a name="comment_{{ comment.id }}"></a>
             <h4 class="col-sm-3">
                 <strong>{{ comment.author.fullName }}</strong> {{ 'post.commented_on'|trans }}
-                {# it's not mandatory to set the timezone in localizeddate(). This is done to
-                   avoid errors when the 'intl' PHP extension is not available and the application
-                   is forced to use the limited "intl polyfill", which only supports UTC and GMT #}
+                {#
+                    It's not mandatory to set the timezone in format_datetime(). This is done to
+                    avoid errors when the 'intl' PHP extension is not available and the application
+                    is forced to use the limited "intl polyfill", which only supports UTC and GMT
+                #}
                 <strong>{{ comment.publishedAt|format_datetime('medium', 'short', '', 'UTC') }}</strong>
             </h4>
             <div class="col-sm-9">
@@ -69,9 +74,11 @@
         </div>
     {% endif %}
 
-    {# the parent() function includes the contents defined by the parent template
-      ('base.html.twig') for this block ('sidebar'). This is a very convenient way
-      to share common contents in different templates #}
+    {#
+        The parent() function includes the contents defined by the parent template
+        ('base.html.twig') for this block ('sidebar'). This is a very convenient way
+        to share common contents in different templates
+    #}
     {{ parent() }}
 
     {{ show_source_code(_self) }}
diff --git a/templates/default/_flash_messages.html.twig b/templates/default/_flash_messages.html.twig
@@ -1,18 +1,18 @@
 {#
-   This is a template fragment designed to be included in other templates
-   See https://symfony.com/doc/current/templates.html#including-templates
+    This is a template fragment designed to be included in other templates
+    See https://symfony.com/doc/current/templates.html#including-templates
 
-   A common practice to better distinguish between templates and fragments is to
-   prefix fragments with an underscore. That's why this template is called
-   '_flash_messages.html.twig' instead of 'flash_messages.html.twig'
+    A common practice to better distinguish between templates and fragments is to
+    prefix fragments with an underscore. That's why this template is called
+    '_flash_messages.html.twig' instead of 'flash_messages.html.twig'
 #}
 
 {#
-   The check is needed to prevent starting the session when looking for "flash messages":
-   https://symfony.com/doc/current/session.html#avoid-starting-sessions-for-anonymous-users
+    The check is needed to prevent starting the session when looking for "flash messages":
+    https://symfony.com/doc/current/session.html#avoid-starting-sessions-for-anonymous-users
 
-   TIP: With FOSHttpCache you can also adapt this to make it cache safe:
-   https://foshttpcachebundle.readthedocs.io/en/latest/features/helpers/flash-message.html
+    TIP: With FOSHttpCache you can also adapt this to make it cache safe:
+    https://foshttpcachebundle.readthedocs.io/en/latest/features/helpers/flash-message.html
 #}
 {% if app.request.hasPreviousSession %}
     <div class="messages">
diff --git a/templates/form/fields.html.twig b/templates/form/fields.html.twig
@@ -1,10 +1,10 @@
 {#
-   Each field type is rendered by a template fragment, which is determined
-   by the name of your form type class (DateTimePickerType -> date_time_picker)
-   and the suffix "_widget". This can be controlled by overriding getBlockPrefix()
-   in DateTimePickerType.
+    Each field type is rendered by a template fragment, which is determined
+    by the name of your form type class (DateTimePickerType -> date_time_picker)
+    and the suffix "_widget". This can be controlled by overriding getBlockPrefix()
+    in DateTimePickerType.
 
-   See https://symfony.com/doc/current/form/create_custom_field_type.html#creating-the-form-type-template
+    See https://symfony.com/doc/current/form/create_custom_field_type.html#creating-the-form-type-template
 #}
 
 {% block date_time_picker_widget %}
