docs: replace $description with $class-description for class words

char-rename
Alexander Iljin 2016-07-28 20:39:43 +03:00 committed by John Benediktsson
parent a337a0349d
commit 1aded9abdd
15 changed files with 17 additions and 17 deletions

View File

@ -40,7 +40,7 @@ HELP: ?{
{ $examples { $code "?{ t f t }" } } ; { $examples { $code "?{ t f t }" } } ;
HELP: bit-array HELP: bit-array
{ $description "The class of fixed-length bit arrays." } ; { $class-description "The class of fixed-length bit arrays." } ;
HELP: <bit-array> HELP: <bit-array>
{ $values { "n" "a non-negative integer" } { "bit-array" "a new " { $link bit-array } } } { $values { "n" "a non-negative integer" } { "bit-array" "a new " { $link bit-array } } }

View File

@ -22,7 +22,7 @@ $nl
ABOUT: "bit-vectors" ABOUT: "bit-vectors"
HELP: bit-vector HELP: bit-vector
{ $description "The class of resizable bit vectors. See " { $link "bit-vectors" } " for information." } ; { $class-description "The class of resizable bit vectors. See " { $link "bit-vectors" } " for information." } ;
HELP: <bit-vector> HELP: <bit-vector>
{ $values { "capacity" "a positive integer specifying initial capacity" } { "vector" bit-vector } } { $values { "capacity" "a positive integer specifying initial capacity" } { "vector" bit-vector } }

View File

@ -8,14 +8,14 @@ HELP: new-dispatcher
{ $description "Creates a new instance of a subclass of " { $link dispatcher } "." } ; { $description "Creates a new instance of a subclass of " { $link dispatcher } "." } ;
HELP: dispatcher HELP: dispatcher
{ $description "The class of dispatchers. May be subclassed, in which case subclasses should be constructed by calling " { $link new-dispatcher } "." } ; { $class-description "The class of dispatchers. May be subclassed, in which case subclasses should be constructed by calling " { $link new-dispatcher } "." } ;
HELP: <dispatcher> HELP: <dispatcher>
{ $values { "dispatcher" dispatcher } } { $values { "dispatcher" dispatcher } }
{ $description "Creates a new pathname dispatcher." } ; { $description "Creates a new pathname dispatcher." } ;
HELP: vhost-dispatcher HELP: vhost-dispatcher
{ $description "The class of virtual host dispatchers." } ; { $class-description "The class of virtual host dispatchers." } ;
HELP: <vhost-dispatcher> HELP: <vhost-dispatcher>
{ $values { "dispatcher" vhost-dispatcher } } { $values { "dispatcher" vhost-dispatcher } }

View File

@ -2,7 +2,7 @@ USING: help.markup help.syntax http.server ;
IN: http.server.filters IN: http.server.filters
HELP: filter-responder HELP: filter-responder
{ $description "The class of filter responders. This class is intended to be subclassed." } ; { $class-description "The class of filter responders. This class is intended to be subclassed." } ;
ARTICLE: "http.server.filters" "HTTP responder filters" ARTICLE: "http.server.filters" "HTTP responder filters"
"The " { $vocab-link "http.server.filters" } " vocabulary implements the common pattern where one responder wraps another, doing some processing before calling the wrapped responder." "The " { $vocab-link "http.server.filters" } " vocabulary implements the common pattern where one responder wraps another, doing some processing before calling the wrapped responder."

View File

@ -4,7 +4,7 @@ USE: html.forms ! needed for $link in param
IN: http.server IN: http.server
HELP: trivial-responder HELP: trivial-responder
{ $description "The class of trivial responders, which output the same response for every request. New instances are created by calling " { $link <trivial-responder> } "." } ; { $class-description "The class of trivial responders, which output the same response for every request. New instances are created by calling " { $link <trivial-responder> } "." } ;
HELP: <trivial-responder> HELP: <trivial-responder>
{ $values { "response" response } { "trivial-responder" trivial-responder } } { $values { "response" response } { "trivial-responder" trivial-responder } }

View File

@ -43,7 +43,7 @@ $nl
ABOUT: "arrays" ABOUT: "arrays"
HELP: array HELP: array
{ $description "The class of fixed-length arrays. See " { $link "syntax-arrays" } " for syntax and " { $link "arrays" } " for general information." } ; { $class-description "The class of fixed-length arrays. See " { $link "syntax-arrays" } " for syntax and " { $link "arrays" } " for general information." } ;
HELP: <array> HELP: <array>
{ $values { "n" "a non-negative integer" } { "elt" "an initial element" } { "array" "a new array" } } { $values { "n" "a non-negative integer" } { "elt" "an initial element" } { "array" "a new array" } }

View File

@ -28,7 +28,7 @@ $nl
ABOUT: "byte-arrays" ABOUT: "byte-arrays"
HELP: byte-array HELP: byte-array
{ $description "The class of byte arrays. See " { $link "syntax-byte-arrays" } " for syntax and " { $link "byte-arrays" } " for general information." } ; { $class-description "The class of byte arrays. See " { $link "syntax-byte-arrays" } " for syntax and " { $link "byte-arrays" } " for general information." } ;
HELP: <byte-array> HELP: <byte-array>
{ $values { "n" "a non-negative integer" } { "byte-array" "a new byte array" } } { $values { "n" "a non-negative integer" } { "byte-array" "a new byte array" } }

View File

@ -22,7 +22,7 @@ $nl
ABOUT: "byte-vectors" ABOUT: "byte-vectors"
HELP: byte-vector HELP: byte-vector
{ $description "The class of resizable byte vectors. See " { $link "byte-vectors" } " for information." } ; { $class-description "The class of resizable byte vectors. See " { $link "byte-vectors" } " for information." } ;
HELP: <byte-vector> HELP: <byte-vector>
{ $values { "n" "a positive integer specifying initial capacity" } { "byte-vector" byte-vector } } { $values { "n" "a positive integer specifying initial capacity" } { "byte-vector" byte-vector } }

View File

@ -58,7 +58,7 @@ ARTICLE: "hashtables.utilities" "Hashtable utilities"
ABOUT: "hashtables" ABOUT: "hashtables"
HELP: hashtable HELP: hashtable
{ $description "The class of hashtables. See " { $link "syntax-hashtables" } " for syntax and " { $link "hashtables" } " for general information." } ; { $class-description "The class of hashtables. See " { $link "syntax-hashtables" } " for syntax and " { $link "hashtables" } " for general information." } ;
HELP: hash@ HELP: hash@
{ $values { "key" "a key" } { "array" "the underlying array of a hashtable" } { "i" "the index to begin hashtable search" } } { $values { "key" "a key" } { "array" "the underlying array of a hashtable" } { "i" "the index to begin hashtable search" } }

View File

@ -45,7 +45,7 @@ HELP: callable
{ $class-description "The class whose instances can be passed to " { $link call } ". This includes quotations and composed quotations built up with " { $link curry } " or " { $link compose } "." } ; { $class-description "The class whose instances can be passed to " { $link call } ". This includes quotations and composed quotations built up with " { $link curry } " or " { $link compose } "." } ;
HELP: quotation HELP: quotation
{ $description "The class of quotations. See " { $link "syntax-quots" } " for syntax and " { $link "quotations" } " for general information." } ; { $class-description "The class of quotations. See " { $link "syntax-quots" } " for syntax and " { $link "quotations" } " for general information." } ;
HELP: >quotation HELP: >quotation
{ $values { "seq" sequence } { "quot" quotation } } { $values { "seq" sequence } { "quot" quotation } }
@ -61,7 +61,7 @@ HELP: 1quotation
} ; } ;
HELP: wrapper HELP: wrapper
{ $description "The class of wrappers. Wrappers are created by calling " { $link literalize } ". See " { $link "syntax-words" } " for syntax." } ; { $class-description "The class of wrappers. Wrappers are created by calling " { $link literalize } ". See " { $link "syntax-words" } " for syntax." } ;
HELP: <wrapper> HELP: <wrapper>
{ $values { "obj" object } { "wrapper" wrapper } } { $values { "obj" object } { "wrapper" wrapper } }

View File

@ -23,7 +23,7 @@ $nl
ABOUT: "sbufs" ABOUT: "sbufs"
HELP: sbuf HELP: sbuf
{ $description "The class of resizable character strings. See " { $link "syntax-sbufs" } " for syntax and " { $link "sbufs" } " for general information." } ; { $class-description "The class of resizable character strings. See " { $link "syntax-sbufs" } " for syntax and " { $link "sbufs" } " for general information." } ;
HELP: <sbuf> HELP: <sbuf>
{ $values { "n" "a positive integer specifying initial capacity" } { "sbuf" sbuf } } { $values { "n" "a positive integer specifying initial capacity" } { "sbuf" sbuf } }

View File

@ -27,7 +27,7 @@ $nl
ABOUT: "strings" ABOUT: "strings"
HELP: string HELP: string
{ $description "The class of fixed-length character strings. See " { $link "syntax-strings" } " for syntax and " { $link "strings" } " for general information." } ; { $class-description "The class of fixed-length character strings. See " { $link "syntax-strings" } " for syntax and " { $link "strings" } " for general information." } ;
HELP: string-nth HELP: string-nth
{ $values { "n" fixnum } { "string" string } { "ch" "the character at the " { $snippet "n" } "th index" } } { $values { "n" fixnum } { "string" string } { "ch" "the character at the " { $snippet "n" } "th index" } }

View File

@ -28,7 +28,7 @@ $nl
ABOUT: "vectors" ABOUT: "vectors"
HELP: vector HELP: vector
{ $description "The class of resizable vectors. See " { $link "syntax-vectors" } " for syntax and " { $link "vectors" } " for general information." } ; { $class-description "The class of resizable vectors. See " { $link "syntax-vectors" } " for syntax and " { $link "vectors" } " for general information." } ;
HELP: <vector> HELP: <vector>
{ $values { "n" "a positive integer specifying initial capacity" } { "vector" vector } } { $values { "n" "a positive integer specifying initial capacity" } { "vector" vector } }

View File

@ -2,7 +2,7 @@ USING: help.syntax help.markup words.symbol words compiler.units ;
IN: words.symbol IN: words.symbol
HELP: symbol HELP: symbol
{ $description "The class of symbols created by " { $link POSTPONE: SYMBOL: } "." } ; { $class-description "The class of symbols created by " { $link POSTPONE: SYMBOL: } "." } ;
HELP: define-symbol HELP: define-symbol
{ $values { "word" word } } { $values { "word" word } }

View File

@ -245,7 +245,7 @@ HELP: undefined
} ; } ;
HELP: primitive HELP: primitive
{ $description "The class of primitive words." } ; { $class-description "The class of primitive words." } ;
HELP: word-prop HELP: word-prop
{ $values { "word" word } { "name" "a property name" } { "value" "a property value" } } { $values { "word" word } { "name" "a property name" } { "value" "a property value" } }