core/prettyprint/config/config-docs.factor

   1 USING: help.markup help.syntax io kernel prettyprint
   2 prettyprint.sections words ;
   3 IN: prettyprint.config
   4
   5 ABOUT: "prettyprint-variables"
   6
   7 HELP: indent
   8 { $var-description "The prettyprinter's current indent level." } ;
   9
  10 HELP: pprinter-stack
  11 { $var-description "A stack of " { $link block } " objects currently being constructed by the prettyprinter." } ;
  12
  13 HELP: tab-size
  14 { $var-description "Prettyprinter tab size. Indent nesting is always a multiple of the tab size." } ;
  15
  16 HELP: margin
  17 { $var-description "The maximum line length, in characters. Lines longer than the margin are wrapped." } ;
  18
  19 HELP: nesting-limit
  20 { $var-description "The maximum nesting level. Structures that nest further than this will simply print as a pound sign (#). The default is " { $link f } ", denoting unlimited nesting depth." } ;
  21
  22 HELP: length-limit
  23 { $var-description "The maximum printed sequence length. Sequences longer than this are truncated, and \"...\" is output in place of remaining elements. The default is " { $link f } ", denoting unlimited sequence length." } ;
  24
  25 HELP: line-limit
  26 { $var-description "The maximum number of lines output by the prettyprinter before output is truncated with \"...\". The default is " { $link f } ", denoting unlimited line count." } ;
  27
  28 HELP: string-limit
  29 { $var-description "Toggles whether printed strings are truncated to the margin." } ;
  30
  31 HELP: hilite-quotation
  32 { $var-description "If set, printing this quotation will highlight the element with index " { $link hilite-index } " in an output stream-specific manner." } ;
  33
  34 HELP: hilite-index
  35 { $var-description "If set, printing the quotation stored in " { $link hilite-quotation } " will highlight the element with this index in an output stream-specific manner." } ;