core/summary/summary-docs.factor

   1 IN: summary
   2 USING: kernel strings help.markup help.syntax ;
   3
   4 ARTICLE: "summary" "Converting objects to summary strings"
   5 "A word for getting very brief descriptions of words and general objects:"
   6 { $subsections summary } ;
   7
   8 HELP: summary
   9 { $values { "object" object } { "string" string } }
  10 { $contract "Outputs a brief description of the object." }
  11 { $notes "New methods can be defined by user code. Most often, this is used with error classes so that " { $link "debugger" } " can print friendlier error messages." } ;
  12
  13 ABOUT: "summary"