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.

Sign up for GitHub

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

Jump to bottom

[DOC] Fix documentation filter command parameter name #1515

Merged
merged 1 commit into from
May 23, 2023
Merged

[DOC] Fix documentation filter command parameter name #1515

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions Resources/doc/commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ All cache for a given paths will be removed:

$ php bin/console liip:imagine:cache:remove path1 path

If you use ``--filters`` parameter, all cache for a given filters will be lost:
If you use ``--filter`` parameter, all cache for a given filter will be lost:

.. code-block:: bash

$ php bin/console liip:imagine:cache:remove --filters=thumb1 --filters=thumb2
$ php bin/console liip:imagine:cache:remove --filter=thumb1 --filter=thumb2

You can combine these parameters:

.. code-block:: bash

$ php bin/console liip:imagine:cache:remove path1 path2 --filters=thumb1 --filters=thumb2
$ php bin/console liip:imagine:cache:remove path1 path2 --filter=thumb1 --filter=thumb2

Cache for all paths and filters will be lost when executing this command
without parameters:
Expand All @@ -42,7 +42,7 @@ Warm up Cache

.. code-block:: bash

$ php bin/console liip:imagine:cache:resolve path1 path2 --filters=thumb1
$ php bin/console liip:imagine:cache:resolve path1 path2 --filter=thumb1

The cache for those two paths will be warmed up for the specified filter set.
As a result you will get:
Expand All @@ -56,7 +56,7 @@ You can specify which filter sets to warm up:

.. code-block:: bash

$ php bin/console liip:imagine:cache:resolve path1 --filters=thumb1 --filters=thumb2
$ php bin/console liip:imagine:cache:resolve path1 --filter=thumb1 --filter=thumb2

As a result you will get:

Expand All @@ -65,7 +65,7 @@ As a result you will get:
http://localhost/media/cache/thumb1/path1
http://localhost/media/cache/thumb2/path1

If you omit ``--filters``, the image will be warmed up for all available filters:
If you omit ``--filter``, the image will be warmed up for all available filters:

.. code-block:: bash

Expand Down