Add :on_ambiguity attribute documentation

maennchen · Nov 24, 2024 · 833d72a · 833d72a
1 parent bd75787
commit 833d72a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/crontab/cron_expression.ex b/lib/crontab/cron_expression.ex
@@ -92,6 +92,10 @@ defmodule Crontab.CronExpression do
       +-------------- :second Second             (range: 0-59)
 
   The `:extended` attribute defines if the second is taken into account.
+  When using localized DateTime, the `:on_ambiguity` attribute defines
+  whether the scheduler should return the earlier or later time when
+  the next run DateTime is ambiguous. `:on_ambiguity` defaults to `[:later]`.
+  To run on both, set it as `[:earlier, :later]`.
   """
   defstruct extended: false,
             reboot: false,