Skip to content

Commit 66e4ee5

Browse files
Fill naming jobs best practices documentation (#149)
* Update naming-jobs.rst * Update docs/docs/best-practices/naming-jobs.rst --------- Co-authored-by: Yann Eugoné <[email protected]>
1 parent ccadce0 commit 66e4ee5

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/docs/best-practices/naming-jobs.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,35 +12,35 @@ A name is a simple ``string``, with the only requirement that every job must hav
1212
Decide on a convention
1313
------------------------------------------------------------
1414

15-
There is no recommandation we can make here, you can use whatever notation you prefer:
15+
There is no specific recommandation, you can use whichever notation you prefer, such as:
1616

1717
* ``ImportUser``
1818
* ``import_user``
1919
* ``import.user``
20-
* or anything else
20+
* or any other format
2121

22-
But we strongly recommend that you pick a convention and try to stick to it.
22+
However, we strongly recommend that you choose a convention and adhere to it consistently.
2323

2424

2525
In a Symfony project
2626
------------------------------------------------------------
2727

28-
| Because this is how the Framework works, ``Jobs`` must be registered as services.
29-
| All services tagged with ``yokai_batch.job`` are collected in a ``CompilerPass``, and given to the ``JobRegistry``.
28+
| Because of the way the framework works, ``Jobs`` must be registered as services.
29+
| All services tagged with ``yokai_batch.job`` are collected in a ``CompilerPass``, and provided to the ``JobRegistry``.
3030
31-
You can tag manually all your jobs, and fill the job name withing the tag:
31+
You can manually tag all your jobs and specify the job name withing the tag:
3232

3333
.. literalinclude:: naming-jobs/symfony-manual-tag.php
3434
:language: php
3535

36-
You can autoconfigure all services with ``JobInterface`` to be tagged,
37-
and the job name will be the service id (most of the time the FQCN):
36+
Alternatively, you can autoconfigure all services implementing ``JobInterface`` to be tagged.
37+
In this case, the job name will be the service ID (usually the FQCN):
3838

3939
.. literalinclude:: naming-jobs/symfony-autowire-tag.yaml
4040
:language: yaml
4141

42-
Finally, if you want all services to be tagged using autoconfigure, but still want to pick job names,
43-
you can implement ``JobWithStaticNameInterface`` in your jobs:
42+
Finally, if you want to autoconfigure all services while still manually specifying job names,
43+
you can implement the ``JobWithStaticNameInterface`` in your jobs:
4444

4545
.. literalinclude:: naming-jobs/symfony-interface-tag.php
4646
:language: php

0 commit comments

Comments
 (0)