[Icons] Docs: Fixing links to `symfony/ux-twig-component` #2789

ThomasLandauer · 2025-05-28T21:36:38Z

Q	A
Bug fix?	no
New feature?	no
Docs?	yes
Issues
License	MIT

Page: https://symfony.com/bundles/ux-icons/current/index.html

smnandre · 2025-05-29T02:58:24Z

src/Icons/doc/index.rst

 the TwigComponent overhead is reduced by calling the IconRenderer immediately and
 returning the HTML output.

 .. warning::

-    The <twig:ux:icon> component does not support embedded content.
+    The `symfony/ux-twig-component`_ does not support embedded content.


? I think you're missreading this.

The twig:ux:icon component does not support embedded content.

The symfony/ux-twig-component has nothing to do with it, and I don't want to imply anything else regarding twig component.

I think you're missreading this.

Maybe, but I'm certainly not misclicking it :-)
=> What's currently on the page is a broken link!

OK, now I see: In fact, there was just the second backtick missing ;-)
The word "component" was misleading me; so I changed that to "tag".

=> What's currently on the page is a broken link!

Ho i saw that, and thank you for reporting it!

But you changed the meaning on the way and this is another thing that fixing something :)

smnandre · 2025-05-29T02:59:30Z

src/Icons/doc/index.rst

@@ -526,13 +526,13 @@ TwigComponent
 ~~~~~~~~~~~~~

 The ``ux_icon()`` function is optimized to be as fast as possible. To deliver the
-same level of performance when using the HTML syntax (``<twig:ux:icon name="..." />``),
+same level of performance as if using the HTML syntax (``<twig:ux:icon name="..." />``),


No, the original meaning is the current one. The HTML syntax is the name of the syntax of TwigComponents that looks like HTML.

So here it's not "as if" but "when"

What you want to say is:

The twig syntax has the same performance as the HTML syntax.

Right?

Same as in #2781 (review) - let's switch the parts:

The TwigComponent overhead is reduced to deliver the same level of performance when using the HTML syntax

=> No. Cause when I use the twig syntax, I cannot use the HTML syntax at the same time.

Not at all.

What we do say here is : using the Twig function is the fastest possible. When using the Twig Component with the HTML Syntax, we have developed tactics.

Said in another way:

"To deliver the same level of performance when using the HTML syntax... the UX Icon component [...]"

OK, I finally got what you mean. But this is impossible to get across with the current sentence structure. I'll come up with a better suggestion.
But one question first: Is ux_icon() now faster or are they the same?

But one question first: Is ux_icon() now faster or are they the same?

If they are in fact, the same, what about removing this paragraph entirely?

what about removing this paragraph entirely?

I didn't dare to ask that :-)

No, seriously - what about shortening this to something like:

Due to internal optimizations, there is no real speed difference between the Twig and the HTML syntax.

Due to internal optimizations, there is no real speed difference between the Twig and the HTML syntax.

Perfect! They don't need to know how the sausage is made!

But let's keep this PR focused on just the link fix and change this in #2795.

know how the sausage is made

A Canadian saying? :-) But you don't eat that much sausage over there, do you?

OK, I reverted it here. But that other PR is a mess already, so I won't add more stuff there...

src/Icons/doc/index.rst

smnandre

Thanks for the link!

Let's revert the text changes :)

smnandre · 2025-05-29T21:14:04Z

src/Icons/doc/index.rst

@@ -526,13 +526,13 @@ TwigComponent
 ~~~~~~~~~~~~~

 The ``ux_icon()`` function is optimized to be as fast as possible. To deliver the
-same level of performance when using the HTML syntax (``<twig:ux:icon name="..." />``),
+same level of performance as if using the HTML syntax (``<twig:ux:icon name="..." />``),


Not at all.

What we do say here is : using the Twig function is the fastest possible. When using the Twig Component with the HTML Syntax, we have developed tactics.

Said in another way:

"To deliver the same level of performance when using the HTML syntax... the UX Icon component [...]"

smnandre · 2025-05-29T21:14:36Z

src/Icons/doc/index.rst

 the TwigComponent overhead is reduced by calling the IconRenderer immediately and
 returning the HTML output.

 .. warning::

-    The <twig:ux:icon> component does not support embedded content.
+    The ``<twig:ux:icon>`` tag does not support embedded content.


No. I'm sorry. It's not a question of tag but a question of special Twig Component

ThomasLandauer · 2025-05-29T22:37:55Z

Sorry, but I'm starting to lose the overview here. I now brought back the "component"in this sentence:

The <twig:ux:icon> component does not support embedded content.

=> But in fact this entire paragraph needs to be removed, as per what you're saying at #2796 (comment)
But I can't do that right now - need to see how the page looks like after all my changes... ;-)

And reduce the text to:

Due to internal optimizations, there is no real speed difference between the Twig and the HTML syntax.

smnandre · 2025-05-30T02:07:43Z

Thank you Thomas.

carsonbot added Icons Status: Needs Review Needs to be reviewed labels May 28, 2025

smnandre reviewed May 29, 2025

View reviewed changes

src/Icons/doc/index.rst Show resolved Hide resolved

smnandre requested changes May 29, 2025

View reviewed changes

carsonbot added Status: Needs Work Additional work is needed Status: Needs Review Needs to be reviewed and removed Status: Needs Review Needs to be reviewed Status: Needs Work Additional work is needed labels May 29, 2025

smnandre requested changes May 29, 2025

View reviewed changes

carsonbot added Status: Needs Work Additional work is needed Status: Needs Review Needs to be reviewed and removed Status: Needs Review Needs to be reviewed Status: Needs Work Additional work is needed labels May 29, 2025

ThomasLandauer mentioned this pull request May 29, 2025

[Icons]: HTML syntax: Closing the tag with </twig:ux:icon> breaks it #2796

Closed

kbond approved these changes May 29, 2025

View reviewed changes

carsonbot added Status: Reviewed Has been reviewed by a maintainer and removed Status: Needs Review Needs to be reviewed labels May 29, 2025

smnandre approved these changes May 30, 2025

View reviewed changes

[Icons] Docs: Fixing links to symfony/ux-twig-component

58e305d

smnandre force-pushed the patch-6 branch from 3885b28 to 58e305d Compare May 30, 2025 02:07

smnandre merged commit 94f27c1 into symfony:2.x May 30, 2025
1 check passed

ThomasLandauer deleted the patch-6 branch May 30, 2025 10:53

Uh oh!

[Icons] Docs: Fixing links to symfony/ux-twig-component #2789

[Icons] Docs: Fixing links to symfony/ux-twig-component #2789

Uh oh!

Conversation

ThomasLandauer commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ThomasLandauer May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

smnandre left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ThomasLandauer commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

smnandre commented May 30, 2025

Uh oh!

Uh oh!

Uh oh!

[Icons] Docs: Fixing links to `symfony/ux-twig-component` #2789

[Icons] Docs: Fixing links to `symfony/ux-twig-component` #2789

ThomasLandauer commented May 28, 2025 •

edited

Loading

ThomasLandauer May 29, 2025 •

edited

Loading

ThomasLandauer commented May 29, 2025 •

edited

Loading