Liking cljdoc? Tell your friends :D
Clojure only.
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.
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.
documentationclj
(documentation symbol-str)(documentation symbol-str ns)(documentation symbol-str ns options-map)Returns a documentation string that describes the given symbol.
Options map can contain the following options:
- :sources - list of source keywords to use.
Returns a documentation string that describes the given symbol. Options map can contain the following options: - :sources - list of source keywords to use.
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.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close