DESCRIBE

From Tootsville Wiki-Wiki
Jump to: navigation, search

Describe a symbol (word) given. Useful to get on-line documentation of a function (or variable).

Usage[edit]

     (Describe 'Describe)
     
     COMMON-LISP:DESCRIBE
       [symbol]
     
     DESCRIBE names a compiled function:
       Lambda-list: (OBJECT &OPTIONAL (STREAM-DESIGNATOR *STANDARD-OUTPUT*))
       Declared type: (FUNCTION (T &OPTIONAL (OR STREAM BOOLEAN)) (VALUES &OPTIONAL))
       Derived type: (FUNCTION (T &OPTIONAL T) (VALUES &OPTIONAL))
       Documentation:
         Print a description of OBJECT to STREAM-DESIGNATOR.
       Known attributes: unwind, any
       Source file: SYS:SRC;CODE;DESCRIBE.LISP.NEWEST
     ; No value

The “interesting” bit is the line after “Documentation” in the section about being a “compiled function.”

You must put the single quote before the symbol for this to work.