From: Alexander Iljin <ajsoft@yandex.ru>
Date: Thu, 28 Jul 2016 17:39:43 +0000 (+0300)
Subject: docs: replace $description with $class-description for class words
X-Git-Tag: unmaintained~816
X-Git-Url: https://gitweb.factorcode.org/gitweb.cgi?p=factor.git;a=commitdiff_plain;h=1aded9abdd4ff187d847ece7f3ca38f9cc2ff52c

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

diff --git a/basis/bit-arrays/bit-arrays-docs.factor b/basis/bit-arrays/bit-arrays-docs.factor
index 304a33d5a8..3cf59394b7 100644
--- a/basis/bit-arrays/bit-arrays-docs.factor
+++ b/basis/bit-arrays/bit-arrays-docs.factor
@@ -40,7 +40,7 @@ HELP: ?{
 { $examples { $code "?{ t f t }" } } ;
 
 HELP: bit-array
-{ $description "The class of fixed-length bit arrays." } ;
+{ $class-description "The class of fixed-length bit arrays." } ;
 
 HELP: <bit-array>
 { $values { "n" "a non-negative integer" } { "bit-array" "a new " { $link bit-array } } }
diff --git a/basis/bit-vectors/bit-vectors-docs.factor b/basis/bit-vectors/bit-vectors-docs.factor
index 6cea3a00dd..eb931aa18c 100644
--- a/basis/bit-vectors/bit-vectors-docs.factor
+++ b/basis/bit-vectors/bit-vectors-docs.factor
@@ -22,7 +22,7 @@ $nl
 ABOUT: "bit-vectors"
 
 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>
 { $values { "capacity" "a positive integer specifying initial capacity" } { "vector" bit-vector } }
diff --git a/basis/http/server/dispatchers/dispatchers-docs.factor b/basis/http/server/dispatchers/dispatchers-docs.factor
index 3b965574f6..b13774753d 100644
--- a/basis/http/server/dispatchers/dispatchers-docs.factor
+++ b/basis/http/server/dispatchers/dispatchers-docs.factor
@@ -8,14 +8,14 @@ HELP: new-dispatcher
 { $description "Creates a new instance of a subclass of " { $link 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>
 { $values { "dispatcher" dispatcher } }
 { $description "Creates a new pathname dispatcher." } ;
 
 HELP: vhost-dispatcher
-{ $description "The class of virtual host dispatchers." } ;
+{ $class-description "The class of virtual host dispatchers." } ;
 
 HELP: <vhost-dispatcher>
 { $values { "dispatcher" vhost-dispatcher } }
diff --git a/basis/http/server/filters/filters-docs.factor b/basis/http/server/filters/filters-docs.factor
index d05971a39f..3e8781d650 100644
--- a/basis/http/server/filters/filters-docs.factor
+++ b/basis/http/server/filters/filters-docs.factor
@@ -2,7 +2,7 @@ USING: help.markup help.syntax http.server ;
 IN: http.server.filters
 
 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"
 "The " { $vocab-link "http.server.filters" } " vocabulary implements the common pattern where one responder wraps another, doing some processing before calling the wrapped responder."
diff --git a/basis/http/server/server-docs.factor b/basis/http/server/server-docs.factor
index 0efe818872..be09e235a6 100644
--- a/basis/http/server/server-docs.factor
+++ b/basis/http/server/server-docs.factor
@@ -4,7 +4,7 @@ USE: html.forms ! needed for $link in param
 IN: http.server
 
 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>
 { $values { "response" response } { "trivial-responder" trivial-responder } }
diff --git a/core/arrays/arrays-docs.factor b/core/arrays/arrays-docs.factor
index d71649ef6c..3c778e0f43 100644
--- a/core/arrays/arrays-docs.factor
+++ b/core/arrays/arrays-docs.factor
@@ -43,7 +43,7 @@ $nl
 ABOUT: "arrays"
 
 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>
 { $values { "n" "a non-negative integer" } { "elt" "an initial element" } { "array" "a new array" } }
diff --git a/core/byte-arrays/byte-arrays-docs.factor b/core/byte-arrays/byte-arrays-docs.factor
index eeb0832af8..581699ce88 100644
--- a/core/byte-arrays/byte-arrays-docs.factor
+++ b/core/byte-arrays/byte-arrays-docs.factor
@@ -28,7 +28,7 @@ $nl
 ABOUT: "byte-arrays"
 
 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>
 { $values { "n" "a non-negative integer" } { "byte-array" "a new byte array" } }
diff --git a/core/byte-vectors/byte-vectors-docs.factor b/core/byte-vectors/byte-vectors-docs.factor
index 72e3741e72..159a449b9d 100644
--- a/core/byte-vectors/byte-vectors-docs.factor
+++ b/core/byte-vectors/byte-vectors-docs.factor
@@ -22,7 +22,7 @@ $nl
 ABOUT: "byte-vectors"
 
 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>
 { $values { "n" "a positive integer specifying initial capacity" } { "byte-vector" byte-vector } }
diff --git a/core/hashtables/hashtables-docs.factor b/core/hashtables/hashtables-docs.factor
index 2a71345be4..25df26b7fa 100644
--- a/core/hashtables/hashtables-docs.factor
+++ b/core/hashtables/hashtables-docs.factor
@@ -58,7 +58,7 @@ ARTICLE: "hashtables.utilities" "Hashtable utilities"
 ABOUT: "hashtables"
 
 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@
 { $values { "key" "a key" } { "array" "the underlying array of a hashtable" } { "i" "the index to begin hashtable search" } }
diff --git a/core/quotations/quotations-docs.factor b/core/quotations/quotations-docs.factor
index edd79846cd..fa5308c4e1 100644
--- a/core/quotations/quotations-docs.factor
+++ b/core/quotations/quotations-docs.factor
@@ -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 } "." } ;
 
 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
 { $values { "seq" sequence } { "quot" quotation } }
@@ -61,7 +61,7 @@ HELP: 1quotation
 } ;
 
 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>
 { $values { "obj" object } { "wrapper" wrapper } }
diff --git a/core/sbufs/sbufs-docs.factor b/core/sbufs/sbufs-docs.factor
index badf27fa35..24765b1a70 100644
--- a/core/sbufs/sbufs-docs.factor
+++ b/core/sbufs/sbufs-docs.factor
@@ -23,7 +23,7 @@ $nl
 ABOUT: "sbufs"
 
 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>
 { $values { "n" "a positive integer specifying initial capacity" } { "sbuf" sbuf } }
diff --git a/core/strings/strings-docs.factor b/core/strings/strings-docs.factor
index 17fa4ab8c4..0f9af8258a 100644
--- a/core/strings/strings-docs.factor
+++ b/core/strings/strings-docs.factor
@@ -27,7 +27,7 @@ $nl
 ABOUT: "strings"
 
 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
 { $values { "n" fixnum } { "string" string } { "ch" "the character at the " { $snippet "n" } "th index" } }
diff --git a/core/vectors/vectors-docs.factor b/core/vectors/vectors-docs.factor
index 615a52c637..2bab954214 100644
--- a/core/vectors/vectors-docs.factor
+++ b/core/vectors/vectors-docs.factor
@@ -28,7 +28,7 @@ $nl
 ABOUT: "vectors"
 
 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>
 { $values { "n" "a positive integer specifying initial capacity" } { "vector" vector } }
diff --git a/core/words/symbol/symbol-docs.factor b/core/words/symbol/symbol-docs.factor
index 28fc81c6f9..51b0f9d218 100644
--- a/core/words/symbol/symbol-docs.factor
+++ b/core/words/symbol/symbol-docs.factor
@@ -2,7 +2,7 @@ USING: help.syntax help.markup words.symbol words compiler.units ;
 IN: words.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
 { $values { "word" word } }
diff --git a/core/words/words-docs.factor b/core/words/words-docs.factor
index 799b8a886a..f9beeba3b2 100644
--- a/core/words/words-docs.factor
+++ b/core/words/words-docs.factor
@@ -245,7 +245,7 @@ HELP: undefined
 } ;
 
 HELP: primitive
-{ $description "The class of primitive words." } ;
+{ $class-description "The class of primitive words." } ;
 
 HELP: word-prop
 { $values { "word" word } { "name" "a property name" } { "value" "a property value" } }