protocol55.styleguide.alpha — org.clojars.protocol55/styleguide 0.1.1

add clj/s

(add styleguide docs)

Adds the kss documentation maps of docs to styleguide, returning an ordered sequence of sections.

assign-section-ids clj/s

(assign-section-ids docs)

Takes a coll of reference key to kss doc pairs and returns a coll of sections.

base-ref-depth clj/s

(base-ref-depth prev-ref target-ref)

build-weight-map clj/s

(build-weight-map docs)

Retuns a nested map of reference key depths to reference key part to weight.

get-section-by-reference clj/s

(get-section-by-reference styleguide reference)

Returns the section containing the :reference key reference or nil if not present.

max-depth-default clj/s

numeric-reference-regex clj/s

numeric-reference? clj/s

(numeric-reference? x)

prep-styleguide-docs clj/s

(prep-styleguide-docs docs)

prep-styleguide-docs-xf clj/s

reference-doc-pair clj/s

reference-key clj/s

(reference-key reference)

reference-keys-xf clj/s

referenceable-xf clj/s

sections-seq clj/s

(sections-seq styleguide)

(sections-seq base styleguide)

(sections-seq base max-depth styleguide)

(sections-seq base min-depth max-depth styleguide)

Returns an ordered sequence of sections of styleguide constrained by the base, min-depth and max-depth values.

base - a vector of parts the reference must contain (default []) max-depth - the maximum depth of the references parts (default Integer/MAX_VALUE) min-depth - the minimum depth of the references parts (default 0)

styleguide clj/s

(styleguide)

(styleguide docs)

Returns an ordered sequence of sections of the kss documentation maps of docs with :reference keys.

styleguide* clj/s

(styleguide* weight-map docs)

styleguide-pair-xf clj/s

weigh-reference-keys-fn clj/s

(weigh-reference-keys-fn weight-map)

weighted-reference-key clj/s

(weighted-reference-key weight-map ref-key)

weighted-reference-key* clj/s

(weighted-reference-key* w a)

(weighted-reference-key* w a b)

(weighted-reference-key* w a b c)

(weighted-reference-key* w a b c d)

(weighted-reference-key* w a b c d e)

(weighted-reference-key* w a b c d e & more)

weighted-reference-key-compare clj/s

(weighted-reference-key-compare a b)

weighted-reference-key-pad clj/s

(weighted-reference-key-pad k)