Clojure Core

Namespaces

clojure
- core
  - protocols
- data
- inspector
- java
  - browse
  - browse-ui
  - io
  - javadoc
  - shell
- main
- pprint
- reflect
- repl
- set
- stacktrace
- string
- template
- test
  - junit
  - tap
- walk
- xml
- zip

doc source examples comments

1.3.0 permalink

1.3.0

doc

clojure.repl

(doc name)

Prints documentation for a var or special form given its name

1 Example top

link | changes
```
=> (doc map)
;; prints in console:
-------------------------
clojure.core/map
([f coll] [f c1 c2] [f c1 c2 c3] [f c1 c2 c3 & colls])
  Returns a lazy sequence consisting of the result of applying f to the
  set of first items of each coll, followed by applying f to the set
  of second items in each coll, until any one of the colls is
  exhausted.  Any remaining items in other colls are ignored. Function
  f should accept number-of-colls arguments.
```
=> (doc map) ;; prints in console: ------------------------- clojure.core/map ([f coll] [f c1 c2] [f c1 c2 c3] [f c1 c2 c3 & colls]) Returns a lazy sequence consisting of the result of applying f to the set of first items of each coll, followed by applying f to the set of second items in each coll, until any one of the colls is exhausted. Any remaining items in other colls are ignored. Function f should accept number-of-colls arguments.

Source clojure/repl.clj:120 top

(defmacro doc
  "Prints documentation for a var or special form given its name"
  {:added "1.0"}
  [name]
  (if-let [special-name ('{& fn catch try finally try} name)]
    (#'print-doc (#'special-doc special-name))
    (cond
      (special-doc-map name) `(#'print-doc (#'special-doc '~name))
      (resolve name) `(#'print-doc (meta (var ~name)))
      (find-ns name) `(#'print-doc (namespace-doc (find-ns '~name))))))

Vars in clojure.repl/doc:

Used in 0 other vars

Comments top

1 comment(s) for doc.

pjlegato

link

Note that the clojure.repl namespace which contains doc is not loaded by default in Emacs' SLIME mode, because SLIME provides its own doc function via C-c C-d d.

ClojureDocs(beta)