• README

• Docspec

module Docspec

Overview

The main module of the docspec library.

Refer to the top level README for usage.

Defined in:

docspec/version.cr
docspec.cr

Constant Summary

CODEBLOCK_REGEX = /^\s*#\s*```/

COMMENT_REGEX = /^\s*#/

DOCTEST_ANNOTATION_REGEX = /^\s*#\s?\[\]\(@doctest\)/

DOCTEST_PREFIX = /^>>/

DOCTEST_RESULT_PREFIX = /# =>/

VERSION = "0.3.0"

Macro Summary

• doctest(filename)

  Parses filename for marked examples to create specs.

Macro Detail