quil.helpers.docs — quil 3.0.0

Functions for filtering/displaying docs in REPL and generating wiki pages.

all-category-map clj

(all-category-map fn-metas)

Build map idx -> (sub)category. Basically it is merge of category map and all subcategories maps.

fields-as-sorted-set clj

(fields-as-sorted-set fn-metas field)

Make sorted set of all possible values for given field from metas. Example: metas [{:name 1} {:name 2} {:name nil} {:name 2} {:name 3}], field :name will return #{1 2 3}.

link-to-processing-reference clj

(link-to-processing-reference fn-meta)

Builds a link to processing page about the function. If meta has :processing-link key, value will be returned, otherwise method will try to build the link based on processing-name if it is not nil. It processing-name is nil, returns nil.

matching-processing-methods clj

(matching-processing-methods fn-metas orig-name)

Takes a string representing the start of a method name in the original Processing API and returns a map of orig/new-name pairs

pprint-wrapped-lines clj

(pprint-wrapped-lines words
                      &
                      {:keys [fromcolumn width] :or {fromcolumn 0 width 80}})

Pretty print words across several lines by wrapping lines at word boundary.

sorted-category-map clj

(sorted-category-map fn-metas)

Builds map idx -> category. Indices are 1, 2, 3, ... Category is a map with keys :name, :fns, :subcategories. See subcategory-map for format of subcategory.