26504370357
100%

Ran 27 May 2026 09:59AM UTC

Jobs 1

Files 13

Run time 1min

Badge

Embed ▾

Committed 27 May 2026 09:58AM UTC coverage: 99.065%. Remained the same

Build # 26504370357

Build Type

push

github

Committed by

sgerrand

Commit Message

docs(resources): stop framing untested examples as iex sessions

Eight resource modules (Departments, Employees, Locations, My, Rosters,
Sales, Timesheets, Utility) showed `iex>` prompts with hardcoded
expected return values, but no test file ran them as doctests. Readers
copy-pasting would discover the responses are illustrative, not
contractual.

Strip the `iex>`/`...>` prefixes and turn the expected-return lines
into `# => result` comments. The blocks still render as Elixir code in
ExDoc and remain indented under `## Examples`; they just no longer
pretend to be a recorded REPL session.

Also tighten `Deputy.Sales.get_metrics/2`: every `/api/v2/metrics/raw`
query value must be a `String.t()` (Deputy rejects JSON numbers for
`start`/`end`/IDs). Note the wire-type requirement in the param docs
and narrow the spec to
`%{optional(atom() | String.t()) => String.t()} | keyword()`.

Modules with real doctests (`Deputy`, `Deputy.Error`,
`Deputy.Validation`, `Deputy.Constants.*`) are untouched.

Coverage Stats

318 of 321 relevant lines covered (99.07%)

14.88 hits per line

Jobs

ID	Job ID	Ran	Files	Coverage
1	26504370357.1	27 May 2026 09:59AM UTC	13	99.07	GitHub Action Run

sgerrand / ex_deputy / 26504370357
100%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 26504370357

sgerrand / ex_deputy / 26504370357 100%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 26504370357

sgerrand / ex_deputy / 26504370357
100%

README BADGES
x