From 339ee3d9b910d85e59c089024ecd08a6add98e95 Mon Sep 17 00:00:00 2001 From: Marcelo Lauxen Date: Wed, 31 May 2023 07:54:03 -0300 Subject: [PATCH] Docs for https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/440 --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 19c29e81..aa4c9c9d 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,25 @@ The schedule is configured through the `:scheduler:` -> `:schedule` config entry # Enable / disable a job. All jobs are enabled by default. enabled: true + + # Deconstructs a hash defined as the `args` to keyword arguments. + # + # `flase` by default. + # + # Example + # + # my_job: + # cron: '0 0 * * * *' + # class: MyJob + # args: { foo: 'bar', hello: 'world' } + # keyword_argument: true + # + # class MyJob < ActiveJob::Base + # def perform(foo:, hello:) + # # ... + # end + # end + keyword_argument: true ``` ### Schedule metadata