core/prettyprint/describe.facts

   1 IN: tools
   2 USING: help io kernel prettyprint words ;
   3
   4 HELP: sheet
   5 { $values { "object" "an object" } { "sheet" "a sequence of sequences" } }
   6 { $contract "Outputs a representation of the object for the " { $link describe } " word, which is a table where each row corresponds to an object slot, and consists of a number of columns, presumably including the slot name and value." } ;
   7
   8 HELP: slot-sheet
   9 { $values { "object" "an object" } { "sheet" "a sequence of sequences" } }
  10 { $description "Outputs a table of object slot names and values. This is used by the default implementation of " { $link sheet } "." } ;
  11
  12 HELP: describe
  13 { $values { "object" "an object" } }
  14 { $description "Print a tabular overview of the object."
  15 $terpri
  16 "For sequences and hashtables, this outputs the entries of the collection. For all other object types, slot names and values are shown." }
  17 { $notes "Slot values are converted to strings using " { $link unparse-short } "." }
  18 { $examples { $code "global describe" } } ;
  19
  20 HELP: stack.
  21 { $values { "seq" "a sequence" } }
  22 { $description "Prints an outliner listing elements of a sequence in reverse order. Elements are coverted to strings using " { $link unparse-short } "." }
  23 { $notes "This word is used in the implementation of " { $link .s } " and " { $link .r } "." } ;
  24
  25 HELP: callstack.
  26 { $values { "seq" "a sequence" } }
  27 { $description "Displays a sequence output by " { $link callstack } " in a nice way, by highlighting the current execution point in every call frame." } ;
  28
  29 HELP: .c
  30 { $description "Displays the contents of the call stack, with the top of the stack printed first." } ;
  31
  32 HELP: .r
  33 { $description "Displays the contents of the retain stack, with the top of the stack printed first." } ;
  34
  35 HELP: .s
  36 { $description "Displays the contents of the data stack, with the top of the stack printed first." } ;