ESpec.DocExample
Defines the ‘extract’ method with parse module content and return %ESpec.DocExample{} structs. The struct is used by ‘ESpec.DocTest’ module to build the specs.
Summary↑
__struct__() | DocExample struct: lhs - console input, rhs - console output, fun_arity - {fun, arity} tuple, line - line where function is definde, type - define the doc spec type (:test, :error to :insepct). Read ‘ESpec.DocTest’ doc for more info |
extract(module) | Extract module docs and returns a list of %ESpec.DocExample{} structs |
Functions
Specs:
- __struct__ :: %ESpec.DocExample{fun_arity: term, lhs: term, line: term, rhs: term, type: term}
DocExample struct: lhs - console input, rhs - console output, fun_arity - {fun, arity} tuple, line - line where function is definde, type - define the doc spec type (:test, :error to :insepct). Read ‘ESpec.DocTest’ doc for more info.
Extract module docs and returns a list of %ESpec.DocExample{} structs