gpedic / ex_q / d7da921520b35e05109c7211ac2e694ce9b04637

100%

push

github

Make the docs consistent with each other and with the code

Use the same terms everywhere: results (not state), {:error, step,
reason, results}, child queue (not sub-pipeline), the queue block (not
the DSL) and the functional API. The ArgumentError for a whole-results
callback with the wrong arity says "all results" to match.

Fix docs that disagreed with the code: returning a successful execute/1
result from a step is unwrapped, only a failed one raises; run/4 accepts
a bare :error and plain values, and step_fun's type now allows plain
values too. The checks example used predicates whose false would be
stored rather than fail the step, so it uses checks that return error
tuples. Writing steps used <- for String.trim, against its own advice.

Also: queue/1 references become queue/2 or "a queue block", the child
error example names a step that exists, README function references link
on hexdocs, the README states the Elixir requirement, and the hex
description drops backticks that show literally.

1 of 1 new or added line in 1 file covered. (100.0%)

170 of 170 relevant lines covered (100.0%)

116.36 hits per line