Clojure Programming/Examples/API Examples/Documentation

From Wikibooks, open books for an open world
Jump to: navigation, search

doc[edit]

user=> (doc +)
-------------------------
clojure.core/+
([] [x] [x y] [x y & more])
  Returns the sum of nums. (+) returns 0.

find-doc[edit]

Prints documentation for any var whose documentation or name contains a match for applied argument (regex, string, pattern).

user=> (find-doc "count")
-------------------------
clojure.core/assoc
([map key val] [map key val & kvs])
  assoc[iate]. When applied to a map, returns a new map of the
    same (hashed/sorted) type, that contains the mapping of key(s) to
    val(s). When applied to a vector, returns a new vector that
    contains val at index. Note - index must be <= (count vector).
-------------------------
clojure.core/count 
...

source[edit]

user=> (use 'clojure.contrib.repl-utils)
user=> (source string?)
(def
 #^{:arglists '([x])
    :doc "Return true if x is a String"}
 string? (fn string? [x] (instance? String x)))