basis/prettyprint/config/config-docs.factor

   1 USING: help.markup help.syntax io kernel
   2 prettyprint.sections words ;
   3 IN: prettyprint.config
   4
   5 ABOUT: "prettyprint-variables"
   6
   7 HELP: tab-size
   8 { $var-description "Prettyprinter tab size. Indent nesting is always a multiple of the tab size." } ;
   9
  10 HELP: margin
  11 { $var-description "The maximum line length, in characters. Lines longer than the margin are wrapped." } ;
  12
  13 HELP: nesting-limit
  14 { $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." } ;
  15
  16 HELP: length-limit
  17 { $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." } ;
  18
  19 HELP: line-limit
  20 { $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." } ;
  21
  22 HELP: string-limit?
  23 { $var-description "Toggles whether printed strings are truncated to the margin." } ;
  24
  25 HELP: boa-tuples?
  26 { $var-description "Toggles whether tuples and structs print in BOA-form or assoc-form." }
  27 { $notes "See " { $link POSTPONE: T{ } " for a description of both literal tuple forms." } ;
  28
  29 HELP: c-object-pointers?
  30 { $var-description "Toggles whether C objects such as structs and direct arrays only print their underlying address. If this flag isn't set, C objects will attempt to print their contents. If a C object points to invalid memory, it will display only its address regardless." } ;