read_doc v0.1.0 ReadDoc.StateMachine

Link to this section Summary

Link to this section Types

Link to this type list_or_unit(t)
list_or_unit(t) :: t | [t]
Link to this type maybe(t)
maybe(t) :: nil | t
Link to this type numbered_line()
numbered_line() :: {String.t(), number()}
Link to this type numbered_lines()
numbered_lines() :: [numbered_line()]
Link to this type pair(lhs, rhs)
pair(lhs, rhs) :: {lhs, rhs}
Link to this type rgx_run_result()
rgx_run_result() :: nil | [String.t()] | [pair(integer(), integer())]
Link to this type string?()
string?() :: maybe(String.t())

Link to this section Functions

Link to this function run(lines, options)
Link to this function run!(lines, options, file)
run!([String.t()], ReadDoc.Options.t(), String.t()) :: [String.t()]