code.doc.check
check-api-element
added in 4.1
(check-api-element project {:keys [namespace table only], :as elem})checks an :api element for unresolved namespaces and entries
(check-api-element {:lookup {}} {:type :api :namespace “std.lib.missing”}) => {:type :missing-namespace :namespace ’std.lib.missing}
check-element
added in 4.1
(check-element project {:keys [type], :as elem})checks a single prepared element, returning a vector of issues
check-failures
added in 4.1
(check-failures input)(check-failures input params)checks pages and returns the total number of issues found
(check-failures :all) (check-failures ’core xt)
check-page
added in 4.1
(check-page key params lookup project)checks a single documentation page for unresolved and failing elements
issues are returned as a vector of maps with :page, :type and details. when :eval is set in params, page facts are executed and failures are reported as :failed-test issues
check-reference-element
added in 4.1
(check-reference-element {:keys [code refer], :as elem})checks a :reference element for the missing reference placeholder
select-pages
added in 4.1
(select-pages lookup input)selects page keys from the lookup given task input