thanos / kathikon / 1277d86c8f0fd6efd193156a5d69a7dde89194f9-PR-30

93%

main: 89%

Pull #30

github

closed #38 - Added ## Examples sections to the public API docstrings. ExDoc will render these in the generated HTML docs.

Modules updated
Module	Coverage
Kathikon
@moduledoc + every public function (insert, schedule, claim, cancel, retry, rerun, dead_jobs, status, history, etc.)
Kathikon.Batch
@moduledoc + start, status, children, results, retry_failed
Kathikon.Report
@moduledoc + all report functions
Kathikon.Worker
Full worker definition + enqueue example in @moduledoc
Kathikon.Job
build, claimable?, backoff_seconds, to_map, history
Kathikon.Scheduler
@moduledoc + schedule, update_schedule, fetch_schedule, cancel_schedule, list_schedules
Kathikon.Cron
Per-function examples (moduledoc already had cron flow)
Kathikon.Storage
@moduledoc + setup/0
Kathikon.Telemetry
@moduledoc + attach_default_logger/0
Kathikon.Config
timezone/0, mnesia_copies/0
Kathikon.Queue
ensure_started/1, start_configured/0
Examples use the same indented code-block style as Kathikon.Cron — illustrative snippets, not doctests, so they don't ed a running app in mix test.

848 of 910 new or added lines in 21 files covered. (93.19%)

982 of 1050 relevant lines covered (93.52%)

66.98 hits per line