From a2b11996eb8e1432629224019d2ded189a00fdec Mon Sep 17 00:00:00 2001 From: zalgonoise Date: Fri, 24 Nov 2023 19:06:50 +0100 Subject: [PATCH] micron/README: updated references with "micron" instead of "cron"; and "cron" instead of "cronString" --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1440f41..05cb4f1 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ Below is a table with all the options available for creating a cron runtime: | Function | Input Parameters | Description | |:---------------------------------------------:|:--------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| | [`WithSelector`](./cron_config.go#L32) | [`sel selector.Selector`](./selector/selector.go#L37) | Configures the with the input [`selector.Selector`](./selector/selector.go#L37). | -| [`WithJob`](./cron_config.go#L54) | `id string`, `cronString string`, [`runners ...executor.Runner`](./executor/executor.go#L40) | Adds a new [`executor.Executor`](./executor/executor.go#L84) to the [`Runtime`](./cron.go#L34) configuration from the input ID, cron string and set of [`executor.Runner`](./executor/executor.go#L40). | +| [`WithJob`](./cron_config.go#L54) | `id string`, `cron string`, [`runners ...executor.Runner`](./executor/executor.go#L40) | Adds a new [`executor.Executor`](./executor/executor.go#L84) to the [`Runtime`](./cron.go#L34) configuration from the input ID, cron string and set of [`executor.Runner`](./executor/executor.go#L40). | | [`WithErrorBufferSize`](./cron_config.go#L84) | `size int` | Defines the capacity of the error channel that the [`Runtime`](./cron.go#L34) exposes in its [`Runtime.Err`](./cron.go#L77) method. | | [`WithMetrics`](./cron_config.go#L97) | [`m cron.Metrics`](./cron_with_metrics.go#L10) | Decorates the [`Runtime`](./cron.go#L34) with the input metrics registry. | | [`WithLogger`](./cron_config.go#L110) | [`logger *slog.Logger`](https://pkg.go.dev/log/slog#Logger) | Decorates the [`Runtime`](./cron.go#L34) with the input logger. | @@ -241,7 +241,7 @@ Below is a table with all the options available for creating a cron job executor |:------------------------------------------------------:|:---------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------:| | [`WithRunners`](./executor/executor_config.go#L29) | [`runners ...Runner`](./executor/executor.go#L40) | Configures the [`Executor`](./executor/executor.go#L84) with the input [`Runner`(s)](./executor/executor.go#L40). | | [`WithScheduler`](./executor/executor_config.go#L61) | [`sched schedule.Scheduler`](./schedule/scheduler.go#L24) | Configures the [`Executor`](./executor/executor.go#L84) with the input [`schedule.Scheduler`](./schedule/scheduler.go#L24). | -| [`WithSchedule`](./executor/executor_config.go#L78) | `cronString string` | Configures the [`Executor`](./executor/executor.go#L84) with a [`schedule.Scheduler`](./schedule/scheduler.go#L24) using the input cron string. | +| [`WithSchedule`](./executor/executor_config.go#L78) | `cron string` | Configures the [`Executor`](./executor/executor.go#L84) with a [`schedule.Scheduler`](./schedule/scheduler.go#L24) using the input cron string. | | [`WithLocation`](./executor/executor_config.go#L96) | `loc *time.Location` | Configures the [`Executor`](./executor/executor.go#L84) with a [`schedule.Scheduler`](./schedule/scheduler.go#L24) using the input `time.Location`. | | [`WithMetrics`](./executor/executor_config.go#L109) | [`m executor.Metrics`](./executor/executor_with_metrics.go#L11) | Decorates the [`Executor`](./executor/executor.go#L84) with the input metrics registry. | | [`WithLogger`](./executor/executor_config.go#L122) | [`logger *slog.Logger`](https://pkg.go.dev/log/slog#Logger) | Decorates the [`Executor`](./executor/executor.go#L84) with the input logger. | @@ -285,7 +285,7 @@ Below is a table with all the options available for creating a cron job schedule | Function | Input Parameters | Description | |:------------------------------------------------------:|:---------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------:| -| [`WithSchedule`](./schedule/scheduler_config.go#L23) | `cronString string` | Configures the [`Scheduler`](./schedule/scheduler.go#L24) with the input cron string. | +| [`WithSchedule`](./schedule/scheduler_config.go#L23) | `cron string` | Configures the [`Scheduler`](./schedule/scheduler.go#L24) with the input cron string. | | [`WithLocation`](./schedule/scheduler_config.go#L38) | `loc *time.Location` | Configures the [`Scheduler`](./schedule/scheduler.go#L24) with the input `time.Location`. | | [`WithMetrics`](./schedule/scheduler_config.go#L51) | [`m executor.Metrics`](./schedule/scheduler_with_metrics.go#L11) | Decorates the [`Scheduler`](./schedule/scheduler.go#L24) with the input metrics registry. | | [`WithLogger`](./schedule/scheduler_config.go#L64) | [`logger *slog.Logger`](https://pkg.go.dev/log/slog#Logger) | Decorates the [`Scheduler`](./schedule/scheduler.go#L24) with the input logger. | @@ -460,7 +460,7 @@ As mentioned before, this package exposes a [`Parse` function](./schedule/cronle string returning a [`Schedule`](./schedule/cronlex/process.go#L33) and an error: ```go -func Parse(cronString string) (s Schedule, err error) +func Parse(cron string) (s Schedule, err error) ``` This is a process broken down in three phases that can be explored individually, having into consideration that the