Skip to content

[Icons] Docs: Some typos #2781

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 1 commit into from
May 29, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/Icons/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The icon ``name`` is the same as the file name without the file extension (e.g.

.. caution::

The name must match a standard ``slug`` format: ``[a-z0-9-]+(-[0-9a-z])+``.
The name must match a standard ``slug`` format: ``[a-z0-9-]+(-[a-z0-9])+``.

Depending on your configuration, the ``prefix`` can be the name of an icon set, a directory
where the icon is located, or a combination of both.
Expand Down Expand Up @@ -237,7 +237,7 @@ site *on-demand*:
fetched (and cached).

That's all. This works by using the `Iconify`_ API (to which `ux.symfony.com/icons`_
is a frontend for) to fetch the icon and render it in place. This icon is then cached
is a frontend) to fetch the icon and render it in place. This icon is then cached
Copy link
Member

@Kocal Kocal May 28, 2025

Choose a reason for hiding this comment

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

I'm not super-fluent in english, but to me the previous version sounds better, no?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just switch the parts:

ux.symfony.com/icons is a frontend for the the Iconify API

=> OK

ux.symfony.com/icons is a frontend to the the Iconify API

=> OK

ux.symfony.com/icons is a frontend to for the the Iconify API

=> Not OK

Copy link
Member

Choose a reason for hiding this comment

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

Thanks!

for future requests for the same icon.

.. note::
Expand Down Expand Up @@ -291,7 +291,7 @@ the report to overwrite existing icons by using the ``--force`` option:
The process to find icons to lock in your Twig templates is imperfect. It
looks for any string that matches the pattern ``something:something`` so
it's probable there will be false positives. This command should not be used
to audit the icons in your templates in an automated way. Add ``-v`` see
to audit the icons in your templates in an automated way. Add ``-v`` to see
*potential* invalid icons:

.. code-block:: terminal
Expand Down