Liking cljdoc? Tell your friends :D

compliment.core

Core namespace. Most interactions with Compliment should happen through functions defined here.

Core namespace. Most interactions with Compliment should happen
through functions defined here.
raw docstring

all-filesclj

List of all Compliment files in an order they should be loaded. This is required by REPLy.

List of all Compliment files in an order they should be loaded. This is
required by REPLy.
sourceraw docstring

completionsclj

(completions prefix)
(completions prefix options-map)

Returns a list of completions for the given prefix. Options map can contain the following options:

  • :ns - namespace where completion is initiated;
  • :context - code form around the prefix;
  • :sort-order (either :by-length or :by-name);
  • :plain-candidates - if true, returns plain strings instead of maps;
  • :extra-metadata - set of extra fields to add to the maps;
  • :sources - list of source keywords to use.
Returns a list of completions for the given prefix. Options map can contain
the following options:
- :ns - namespace where completion is initiated;
- :context - code form around the prefix;
- :sort-order (either :by-length or :by-name);
- :plain-candidates - if true, returns plain strings instead of maps;
- :extra-metadata - set of extra fields to add to the maps;
- :sources - list of source keywords to use.
sourceraw docstring

documentationclj

(documentation symbol-str)
(documentation symbol-str ns)

Returns a documentation string that describes the given symbol.

Returns a documentation string that describes the given symbol.
sourceraw docstring

ensure-nsclj

(ensure-ns nspc)

Takes either a namespace object or a symbol and returns the corresponding namespace if it exists, otherwise returns user namespace.

Takes either a namespace object or a symbol and returns the corresponding
namespace if it exists, otherwise returns `user` namespace.
sourceraw docstring

sort-by-lengthclj

(sort-by-length candidates)

Sorts list of strings by their length first, and then alphabetically if length is equal. Works for tagged and non-tagged results.

Sorts list of strings by their length first, and then alphabetically if
length is equal. Works for tagged and non-tagged results.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close