minor #19429 [Scheduler] Document hashed cron expressions (javiereguiluz)

javiereguiluz · javiereguiluz · commit 95b2026d0ec0 · 2024-01-17T08:52:56.000+01:00
This PR was merged into the 6.3 branch. Discussion ---------- [Scheduler] Document hashed cron expressions Fixes #18255. I took the list of expressions from the PR #18290 created by `@andreybolonin` Commits ------- 0213c09 [Scheduler] Document hashed cron expressions
diff --git a/scheduler.rst b/scheduler.rst
@@ -157,15 +157,28 @@ class, as shown in the following examples.
 Cron Expression Triggers
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-It uses the same syntax as the `cron command-line utility`_::
+Before using cron triggers, you have to install the following dependency:
+
+.. code-block:: terminal
+
+    composer require dragonmantank/cron-expression
+
+Then, define the trigger date/time using the same syntax as the
+`cron command-line utility`_::
 
     RecurringMessage::cron('* * * * *', new Message());
 
-Before using it, you have to install the following dependency:
+You can also used some special values that represent common cron expressions:
 
-.. code-block:: terminal
+* ``#yearly``, ``#annually`` - Run once a year, midnight, Jan. 1 - ``0 0 1 1 *``
+* ``#monthly`` - Run once a month, midnight, first of month - ``0 0 1 * *``
+* ``#weekly`` - Run once a week, midnight on Sun - ``0 0 * * 0``
+* ``#daily``, ``#midnight`` - Run once a day, midnight - ``0 0 * * *``
+* ``#hourly`` - Run once an hour, first minute - ``0 * * * *``
 
-    composer require dragonmantank/cron-expression
+For example::
+
+    RecurringMessage::cron('#daily', new Message());
 
 .. tip::
 
