From e3cb32504015ca0206abf30a96f5f7009ab0549e Mon Sep 17 00:00:00 2001 From: Doug Coleman Date: Thu, 2 Jul 2015 10:31:22 -0700 Subject: [PATCH] factor: clean up whitespace in -docs files --- .../alien/destructors/destructors-docs.factor | 2 +- basis/bit-arrays/bit-arrays-docs.factor | 2 +- basis/bit-vectors/bit-vectors-docs.factor | 3 +- basis/bitstreams/bitstreams-docs.factor | 1 - basis/channels/channels-docs.factor | 2 +- basis/channels/remote/remote-docs.factor | 14 +- basis/classes/struct/struct-docs.factor | 2 +- basis/cocoa/cocoa-docs.factor | 2 +- basis/cocoa/nibs/nibs-docs.factor | 4 +- basis/colors/constants/constants-docs.factor | 2 +- basis/colors/gray/gray-docs.factor | 2 +- basis/colors/hsv/hsv-docs.factor | 2 +- .../count-downs/count-downs-docs.factor | 2 +- .../core-foundation/arrays/arrays-docs.factor | 1 - .../bundles/bundles-docs.factor | 1 - basis/definitions/icons/icons-docs.factor | 2 +- basis/delegate/delegate-docs.factor | 4 +- basis/fry/fry-docs.factor | 6 +- basis/furnace/actions/actions-docs.factor | 4 +- .../generalizations-docs.factor | 16 +- basis/graphs/graphs-docs.factor | 2 +- basis/help/apropos/apropos-docs.factor | 2 +- basis/help/vocabs/vocabs-docs.factor | 2 +- basis/html/templates/chloe/chloe-docs.factor | 2 +- basis/http/server/rewrite/rewrite-docs.factor | 2 +- basis/inspector/inspector-docs.factor | 2 +- .../hierarchy/hierarchy-docs.factor | 2 +- .../encodings/8-bit/arabic/arabic-docs.factor | 2 +- .../8-bit/cyrillic/cyrillic-docs.factor | 2 +- .../encodings/8-bit/ebcdic/ebcdic-docs.factor | 2 +- .../encodings/8-bit/greek/greek-docs.factor | 2 +- .../encodings/8-bit/koi8-r/koi8-r-docs.factor | 2 +- .../encodings/8-bit/latin1/latin1-docs.factor | 2 +- .../8-bit/latin10/latin10-docs.factor | 2 +- .../encodings/8-bit/latin2/latin2-docs.factor | 2 +- .../encodings/8-bit/latin3/latin3-docs.factor | 2 +- .../encodings/8-bit/latin4/latin4-docs.factor | 2 +- .../encodings/8-bit/latin5/latin5-docs.factor | 2 +- .../encodings/8-bit/latin6/latin6-docs.factor | 2 +- .../encodings/8-bit/latin7/latin7-docs.factor | 2 +- .../encodings/8-bit/latin8/latin8-docs.factor | 2 +- .../8-bit/mac-roman/mac-roman-docs.factor | 2 +- .../io/encodings/8-bit/thai/thai-docs.factor | 2 +- .../windows-1252/windows-1252-docs.factor | 2 +- basis/io/encodings/binary/binary-docs.factor | 2 +- basis/io/encodings/euc-kr/euc-kr-docs.factor | 2 +- basis/io/encodings/iana/iana-docs.factor | 2 +- basis/io/encodings/johab/johab-docs.factor | 2 +- basis/io/encodings/string/string-docs.factor | 2 +- basis/io/encodings/utf32/utf32-docs.factor | 1 - basis/io/ports/ports-docs.factor | 6 +- basis/io/sockets/icmp/icmp-docs.factor | 1 - basis/io/streams/null/null-docs.factor | 2 +- .../io/streams/throwing/throwing-docs.factor | 4 +- basis/json/writer/writer-docs.factor | 2 +- basis/linked-assocs/linked-assocs-docs.factor | 2 +- basis/match/match-docs.factor | 18 +- .../math/quaternions/quaternions-docs.factor | 1 - basis/math/ranges/ranges-docs.factor | 2 +- basis/math/ratios/ratios-docs.factor | 1 - basis/math/statistics/statistics-docs.factor | 2 +- basis/mime/types/types-docs.factor | 6 +- basis/mirrors/mirrors-docs.factor | 2 +- basis/models/models-docs.factor | 6 +- basis/models/range/range-docs.factor | 4 +- .../annotations/annotations-docs.factor | 2 +- basis/opengl/gl/gl-docs.factor | 2 - basis/opengl/shaders/shaders-docs.factor | 2 +- basis/opengl/textures/textures-docs.factor | 1 - basis/peg/parsers/parsers-docs.factor | 4 +- basis/peg/search/search-docs.factor | 1 - basis/promises/promises-docs.factor | 2 +- basis/random/random-docs.factor | 6 +- basis/refs/refs-docs.factor | 8 +- basis/roman/roman-docs.factor | 18 +- basis/serialize/serialize-docs.factor | 2 +- .../specialized-vectors-docs.factor | 2 +- .../continuations/continuations-docs.factor | 2 +- basis/tools/coverage/coverage-docs.factor | 14 +- .../coverage/testvocab/testvocab-docs.factor | 1 - basis/tools/errors/errors-docs.factor | 2 +- basis/tuple-arrays/tuple-arrays-docs.factor | 2 +- basis/ui/commands/commands-docs.factor | 2 +- .../gadgets/grid-lines/grid-lines-docs.factor | 2 +- .../line-support/line-support-docs.factor | 2 +- .../presentations/presentations-docs.factor | 4 +- basis/ui/gadgets/tables/tables-docs.factor | 2 +- basis/ui/gadgets/worlds/worlds-docs.factor | 1 - basis/ui/pens/pens-docs.factor | 4 +- basis/ui/render/render-docs.factor | 2 +- basis/ui/text/text-docs.factor | 2 +- basis/ui/tools/browser/browser-docs.factor | 2 +- basis/unix/groups/groups-docs.factor | 2 +- basis/uuid/uuid-docs.factor | 16 +- basis/validators/validators-docs.factor | 2 +- basis/wrap/strings/strings-docs.factor | 1 - basis/wrap/wrap-docs.factor | 2 +- basis/xml/entities/entities-docs.factor | 1 - basis/xml/syntax/syntax-docs.factor | 2 +- core/byte-vectors/byte-vectors-docs.factor | 2 +- core/checksums/checksums-docs.factor | 2 +- core/classes/builtin/builtin-docs.factor | 1 - core/effects/parser/parser-docs.factor | 1 - core/generic/hook/hook-docs.factor | 2 +- core/io/streams/c/c-docs.factor | 2 +- core/math/math-docs.factor | 1 - core/namespaces/namespaces-docs.factor | 4 +- core/parser/notes/notes-docs.factor | 1 - extra/alien/fortran/fortran-docs.factor | 2 +- extra/audio/audio-docs.factor | 2 +- extra/audio/engine/engine-docs.factor | 8 +- .../balloon-bomber/balloon-bomber-docs.factor | 8 +- extra/bitcoin/client/client-docs.factor | 168 +++++++++--------- extra/brainfuck/brainfuck-docs.factor | 4 +- extra/combinators/extras/extras-docs.factor | 2 - extra/cpu/8080/8080-docs.factor | 4 +- extra/cpu/8080/emulator/emulator-docs.factor | 10 +- extra/fonts/syntax/syntax-docs.factor | 2 +- extra/game/models/obj/obj-docs.factor | 1 - extra/game/worlds/worlds-docs.factor | 2 +- extra/gpu/buffers/buffers-docs.factor | 4 +- .../gpu/framebuffers/framebuffers-docs.factor | 2 +- extra/gpu/render/render-docs.factor | 8 +- extra/gpu/shaders/shaders-docs.factor | 2 +- extra/gpu/state/state-docs.factor | 28 +-- extra/gpu/textures/textures-docs.factor | 2 +- extra/graphviz/dot/dot-docs.factor | 2 +- extra/id3/id3-docs.factor | 4 +- extra/ini-file/ini-file-docs.factor | 1 - extra/lunar-rescue/lunar-rescue-docs.factor | 12 +- extra/math/analysis/analysis-docs.factor | 1 - extra/math/binpack/binpack-docs.factor | 5 +- extra/math/blas/matrices/matrices-docs.factor | 2 +- extra/math/blas/vectors/vectors-docs.factor | 3 +- .../derivatives/syntax/syntax-docs.factor | 2 +- extra/math/dual/dual-docs.factor | 10 +- extra/math/finance/finance-docs.factor | 8 +- extra/math/transforms/haar/haar-docs.factor | 1 - extra/memcached/memcached-docs.factor | 3 +- extra/method-chains/method-chains-docs.factor | 2 +- extra/mongodb/driver/driver-docs.factor | 10 +- extra/mongodb/mongodb-docs.factor | 2 +- extra/ntp/ntp-docs.factor | 1 - extra/opencl/opencl-docs.factor | 4 +- extra/pair-rocket/pair-rocket-docs.factor | 1 - .../simple/simple-docs.factor | 24 +-- extra/pop3/pop3-docs.factor | 18 +- extra/progress-bars/models/models-docs.factor | 6 +- extra/roles/roles-docs.factor | 8 +- extra/s3/s3-docs.factor | 50 +++--- .../space-invaders/space-invaders-docs.factor | 12 +- extra/trees/avl/avl-docs.factor | 2 +- extra/trees/splay/splay-docs.factor | 2 +- extra/wordtimer/wordtimer-docs.factor | 10 +- 154 files changed, 378 insertions(+), 415 deletions(-) diff --git a/basis/alien/destructors/destructors-docs.factor b/basis/alien/destructors/destructors-docs.factor index fcc56abe43..82755c15dd 100644 --- a/basis/alien/destructors/destructors-docs.factor +++ b/basis/alien/destructors/destructors-docs.factor @@ -27,4 +27,4 @@ ARTICLE: "alien.destructors" "Alien destructors" "The " { $vocab-link "alien.destructors" } " vocabulary defines a utility parsing word for defining new disposable classes." { $subsections POSTPONE: DESTRUCTOR: } ; -ABOUT: "alien.destructors" \ No newline at end of file +ABOUT: "alien.destructors" diff --git a/basis/bit-arrays/bit-arrays-docs.factor b/basis/bit-arrays/bit-arrays-docs.factor index 899cfebcaf..304a33d5a8 100644 --- a/basis/bit-arrays/bit-arrays-docs.factor +++ b/basis/bit-arrays/bit-arrays-docs.factor @@ -36,7 +36,7 @@ ABOUT: "bit-arrays" HELP: ?{ { $syntax "?{ elements... }" } { $values { "elements" "a list of booleans" } } -{ $description "Marks the beginning of a literal bit array. Literal bit arrays are terminated by " { $link POSTPONE: } } "." } +{ $description "Marks the beginning of a literal bit array. Literal bit arrays are terminated by " { $link POSTPONE: } } "." } { $examples { $code "?{ t f t }" } } ; HELP: bit-array diff --git a/basis/bit-vectors/bit-vectors-docs.factor b/basis/bit-vectors/bit-vectors-docs.factor index 88ddb0c2a1..6cea3a00dd 100644 --- a/basis/bit-vectors/bit-vectors-docs.factor +++ b/basis/bit-vectors/bit-vectors-docs.factor @@ -35,6 +35,5 @@ HELP: >bit-vector HELP: ?V{ { $syntax "?V{ elements... }" } { $values { "elements" "a list of booleans" } } -{ $description "Marks the beginning of a literal bit vector. Literal bit vectors are terminated by " { $link POSTPONE: } } "." } +{ $description "Marks the beginning of a literal bit vector. Literal bit vectors are terminated by " { $link POSTPONE: } } "." } { $examples { $code "?V{ t f t }" } } ; - diff --git a/basis/bitstreams/bitstreams-docs.factor b/basis/bitstreams/bitstreams-docs.factor index 7963e829be..7be5514275 100644 --- a/basis/bitstreams/bitstreams-docs.factor +++ b/basis/bitstreams/bitstreams-docs.factor @@ -39,4 +39,3 @@ HELP: set-abp HELP: get-abp { $values { "bitstream" bit-reader } { "abp" integer } } { $description "Returns the current position of the bit-reader's read cursor as a number of bits from the start of the stream. The position of the cursor in terms of bytes and bits can be read directly from the bit-reader tuple using " { $link byte-pos>> } " and " { $link bit-pos>> } "." } ; - diff --git a/basis/channels/channels-docs.factor b/basis/channels/channels-docs.factor index 931d424195..125913ad6e 100644 --- a/basis/channels/channels-docs.factor +++ b/basis/channels/channels-docs.factor @@ -30,7 +30,7 @@ HELP: from { "value" object } } { $description "Receives an object from a channel. The operation is synchronous." -" It will block the calling thread until there is data in the channel." +" It will block the calling thread until there is data in the channel." } { $see-also to } ; diff --git a/basis/channels/remote/remote-docs.factor b/basis/channels/remote/remote-docs.factor index bbecb361ea..e07dbe7b3d 100644 --- a/basis/channels/remote/remote-docs.factor +++ b/basis/channels/remote/remote-docs.factor @@ -6,7 +6,7 @@ IN: channels.remote HELP: { $values { "node" "a node object" } - { "id" "the id of the published channel on the node" } + { "id" "the id of the published channel on the node" } { "remote-channel" remote-channel } } { $description "Create a remote channel that acts as a proxy for a " @@ -14,7 +14,7 @@ HELP: "published using " { $link publish } " and the id should be the id " "returned by " { $link publish } } -{ $examples +{ $examples { $code "\"localhost\" 9000 \"ID123456\" \"foo\" over to" } } { $see-also publish unpublish } ; @@ -25,7 +25,7 @@ HELP: unpublish { $description "Stop a previously published channel from being " "accessible by remote nodes." } -{ $examples +{ $examples { $code " publish unpublish" } } { $see-also publish } ; @@ -35,10 +35,10 @@ HELP: publish { "id" string } } { $description "Make a channel accessible via remote Factor nodes. " -"An id is returned that can be used by another node to use " +"An id is returned that can be used by another node to use " { $link to } " and " { $link from } " to access the channel." } -{ $examples +{ $examples { $code " publish" } } { $see-also unpublish } ; @@ -48,7 +48,7 @@ ARTICLE: { "remote-channels" "remote-channels" } "Remote Channels" $nl "To start a remote node, distributed concurrency must have been started. This can be done using " { $link start-server } "." $nl -{ $snippet "\"myhost.com\" 9001 start-server" } +{ $snippet "\"myhost.com\" 9001 start-server" } $nl "Once the node is started, channels can be published using " { $link publish } " to be accessed remotely. " { $link publish } " returns an id which a remote node " @@ -58,7 +58,7 @@ $nl $nl "Given the id from the snippet above, a remote node can put items in the channel (where 123456 is the id):" $nl -{ $snippet "\"myhost.com\" 9001 123456 \n\"hello\" over to" } +{ $snippet "\"myhost.com\" 9001 123456 \n\"hello\" over to" } ; ABOUT: { "remote-channels" "remote-channels" } diff --git a/basis/classes/struct/struct-docs.factor b/basis/classes/struct/struct-docs.factor index 2457e86a1a..e116bc30fb 100644 --- a/basis/classes/struct/struct-docs.factor +++ b/basis/classes/struct/struct-docs.factor @@ -33,7 +33,7 @@ HELP: STRUCT: { $description "Defines a new " { $link struct } " type. The syntax is nearly identical to " { $link POSTPONE: TUPLE: } "; however, there are some additional restrictions on struct types:" { $list { "Struct classes cannot have a superclass defined." } -{ "The slots of a struct must all have a type declared. The type must be a C type." } +{ "The slots of a struct must all have a type declared. The type must be a C type." } { { $link read-only } " slots on structs are not enforced, though they may be declared." } } "Additionally, structs may use bit fields. A slot specifier may use the syntax " { $snippet "bits: n" } " to specify that the bit width of the slot is " { $snippet "n" } ". Bit width may be specified on signed or unsigned integer slots. The layout of bit fields is not guaranteed to match that of any particular C compiler." } ; diff --git a/basis/cocoa/cocoa-docs.factor b/basis/cocoa/cocoa-docs.factor index d0043f55cf..a458d3c633 100644 --- a/basis/cocoa/cocoa-docs.factor +++ b/basis/cocoa/cocoa-docs.factor @@ -18,7 +18,7 @@ HELP: SUPER-> HELP: IMPORT: { $syntax "IMPORT: name" } -{ $description "Makes an Objective C class available for use." } +{ $description "Makes an Objective C class available for use." } { $examples { $code "IMPORT: QTMovie" "QTMovie \"My Movie.mov\" f -> movieWithFile:error:" } } ; diff --git a/basis/cocoa/nibs/nibs-docs.factor b/basis/cocoa/nibs/nibs-docs.factor index b1c3f2a04e..a238d35ae7 100644 --- a/basis/cocoa/nibs/nibs-docs.factor +++ b/basis/cocoa/nibs/nibs-docs.factor @@ -7,10 +7,10 @@ HELP: load-nib HELP: nib-named { $values { "nib-name" string } { "anNSNib" "an instance of NSNib" } } -{ $description "Looks up the " { $snippet ".nib" } " in the main bundle with the given name, instantiating an autoreleased NSNib object. Useful when combined with the " { $link nib-objects } " word. " { $snippet "f" } " is returned in case of error." } +{ $description "Looks up the " { $snippet ".nib" } " in the main bundle with the given name, instantiating an autoreleased NSNib object. Useful when combined with the " { $link nib-objects } " word. " { $snippet "f" } " is returned in case of error." } { $see-also nib-objects } ; HELP: nib-objects { $values { "anNSNib" "an instance of NSNib" } { "objects/f" { $maybe sequence } } } -{ $description "Instantiates the top-level objects of the " { $snippet ".nib" } " file loaded by anNSNib. First create an NSNib instance using " { $link nib-named } "." } +{ $description "Instantiates the top-level objects of the " { $snippet ".nib" } " file loaded by anNSNib. First create an NSNib instance using " { $link nib-named } "." } { $see-also nib-named } ; diff --git a/basis/colors/constants/constants-docs.factor b/basis/colors/constants/constants-docs.factor index 650fb88ae2..2bbc136314 100644 --- a/basis/colors/constants/constants-docs.factor +++ b/basis/colors/constants/constants-docs.factor @@ -30,4 +30,4 @@ ARTICLE: "colors.constants" "Standard color database" POSTPONE: COLOR: } ; -ABOUT: "colors.constants" \ No newline at end of file +ABOUT: "colors.constants" diff --git a/basis/colors/gray/gray-docs.factor b/basis/colors/gray/gray-docs.factor index 4f911f8337..076bdb6671 100644 --- a/basis/colors/gray/gray-docs.factor +++ b/basis/colors/gray/gray-docs.factor @@ -8,4 +8,4 @@ ARTICLE: "colors.gray" "Grayscale colors" } ; -ABOUT: "colors.gray" \ No newline at end of file +ABOUT: "colors.gray" diff --git a/basis/colors/hsv/hsv-docs.factor b/basis/colors/hsv/hsv-docs.factor index a4c037d36a..47dda62fa8 100644 --- a/basis/colors/hsv/hsv-docs.factor +++ b/basis/colors/hsv/hsv-docs.factor @@ -12,4 +12,4 @@ ARTICLE: "colors.hsv" "HSV colors" } { $see-also "colors" } ; -ABOUT: "colors.hsv" \ No newline at end of file +ABOUT: "colors.hsv" diff --git a/basis/concurrency/count-downs/count-downs-docs.factor b/basis/concurrency/count-downs/count-downs-docs.factor index 8d9a64f59d..9acb8ad869 100644 --- a/basis/concurrency/count-downs/count-downs-docs.factor +++ b/basis/concurrency/count-downs/count-downs-docs.factor @@ -3,7 +3,7 @@ IN: concurrency.count-downs HELP: { $values { "n" "a non-negative integer" } { "count-down" count-down } } -{ $description "Creates a new count-down latch." } +{ $description "Creates a new count-down latch." } { $errors "Throws an error if the count is lower than zero." } ; HELP: count-down diff --git a/basis/core-foundation/arrays/arrays-docs.factor b/basis/core-foundation/arrays/arrays-docs.factor index 36d14a8660..ae3622cfdb 100644 --- a/basis/core-foundation/arrays/arrays-docs.factor +++ b/basis/core-foundation/arrays/arrays-docs.factor @@ -8,4 +8,3 @@ HELP: CF>array HELP: { $values { "seq" "a sequence of " { $link alien } " instances" } { "alien" "a " { $snippet "CFArray" } } } { $description "Creates a Core Foundation array from a Factor array." } ; - diff --git a/basis/core-foundation/bundles/bundles-docs.factor b/basis/core-foundation/bundles/bundles-docs.factor index baa1b4d5df..72b4da0b5e 100644 --- a/basis/core-foundation/bundles/bundles-docs.factor +++ b/basis/core-foundation/bundles/bundles-docs.factor @@ -8,4 +8,3 @@ HELP: HELP: load-framework { $values { "name" "a pathname string" } } { $description "Loads a Core Foundation framework." } ; - diff --git a/basis/definitions/icons/icons-docs.factor b/basis/definitions/icons/icons-docs.factor index 7493d4c05a..a4aec7f5b5 100644 --- a/basis/definitions/icons/icons-docs.factor +++ b/basis/definitions/icons/icons-docs.factor @@ -9,4 +9,4 @@ ARTICLE: "definitions.icons" "Definition icons" "Defining new icons:" { $subsections POSTPONE: ICON: } ; -ABOUT: "definitions.icons" \ No newline at end of file +ABOUT: "definitions.icons" diff --git a/basis/delegate/delegate-docs.factor b/basis/delegate/delegate-docs.factor index 30151bd634..634683f526 100644 --- a/basis/delegate/delegate-docs.factor +++ b/basis/delegate/delegate-docs.factor @@ -19,13 +19,13 @@ HELP: define-consult HELP: CONSULT: { $syntax """CONSULT: group class - code ;""" } + code ;""" } { $values { "group" "a protocol, generic word or tuple class" } { "class" "a class" } { "code" "code to get the object to which the method should be forwarded" } } { $description "Declares that objects of " { $snippet "class" } " will delegate the generic words contained in " { $snippet "group" } " to the object returned by executing " { $snippet "code" } " with the original object as an input." { $snippet "CONSULT:" } " will overwrite any existing methods on " { $snippet "class" } " for the members of " { $snippet "group" } ", but new methods can be added after the " { $snippet "CONSULT:" } " to override the delegation." } ; HELP: BROADCAST: { $syntax """BROADCAST: group class - code ;""" } + code ;""" } { $values { "group" "a protocol, generic word or tuple class" } { "class" "a class" } { "code" "code to get the object to which the method should be forwarded" } } { $description "Declares that objects of " { $snippet "class" } " will delegate the generic words contained in " { $snippet "group" } " to every object in the sequence returned by executing " { $snippet "code" } " with the original object as an input." { $snippet "BROADCAST:" } " will overwrite any existing methods on " { $snippet "class" } " for the members of " { $snippet "group" } ", but new methods can be added after the " { $snippet "BROADCAST:" } " to override the delegation. Every generic word in " { $snippet "group" } " must return no outputs; otherwise, a " { $link broadcast-words-must-have-no-outputs } " error will be raised." } ; diff --git a/basis/fry/fry-docs.factor b/basis/fry/fry-docs.factor index eb33f7cd32..db1681dae0 100644 --- a/basis/fry/fry-docs.factor +++ b/basis/fry/fry-docs.factor @@ -31,19 +31,19 @@ $nl "If a quotation does not contain any fry specifiers, then " { $link POSTPONE: '[ } " behaves just like " { $link POSTPONE: [ } ":" { $code "{ 10 20 30 } '[ . ] each" } "Occurrences of " { $link _ } " on the left map directly to " { $link curry } ". That is, the following three lines are equivalent:" -{ $code +{ $code "{ 10 20 30 } 5 '[ _ + ] map" "{ 10 20 30 } 5 [ + ] curry map" "{ 10 20 30 } [ 5 + ] map" } "Occurrences of " { $link _ } " in the middle of a quotation map to more complex quotation composition patterns. The following three lines are equivalent:" -{ $code +{ $code "{ 10 20 30 } 5 '[ 3 _ / ] map" "{ 10 20 30 } 5 [ 3 ] swap [ / ] curry compose map" "{ 10 20 30 } [ 3 5 / ] map" } "Occurrences of " { $link @ } " are simply syntax sugar for " { $snippet "_ call" } ". The following four lines are equivalent:" -{ $code +{ $code "{ 10 20 30 } [ sq ] '[ @ . ] each" "{ 10 20 30 } [ sq ] [ call . ] curry each" "{ 10 20 30 } [ sq ] [ . ] compose each" diff --git a/basis/furnace/actions/actions-docs.factor b/basis/furnace/actions/actions-docs.factor index 76f2ec036a..ad90dd7568 100644 --- a/basis/furnace/actions/actions-docs.factor +++ b/basis/furnace/actions/actions-docs.factor @@ -63,7 +63,7 @@ HELP: validate-params } ; { validate-params validate-values } related-words - + HELP: validation-failed { $description "Stops processing the current request and takes action depending on the type of the current request:" { $list @@ -107,7 +107,7 @@ ARTICLE: "furnace.actions.validation" "Form validation with actions" $nl "A word to validate parameters and make them available as HTML form values (see " { $link "html.forms.values" } "); typically this word is invoked from the " { $slot "init" } " and " { $slot "validate" } " quotations:" { $subsections validate-params } -"The above word expects an association list mapping parameter names to validator quotations; validator quotations can use the words in the " +"The above word expects an association list mapping parameter names to validator quotations; validator quotations can use the words in the " "Custom validation logic can invoke a word when validation fails; " { $link validate-params } " invokes this word for you:" { $subsections validation-failed } "If validation fails, no more action code is executed, and the client is redirected back to the originating page, where validation errors can be displayed. Note that validation errors are rendered automatically by the " { $link "html.components" } " words, and in particular, " { $link "html.templates.chloe" } " use these words." ; diff --git a/basis/generalizations/generalizations-docs.factor b/basis/generalizations/generalizations-docs.factor index f774f1c96a..65000d7cc9 100644 --- a/basis/generalizations/generalizations-docs.factor +++ b/basis/generalizations/generalizations-docs.factor @@ -118,11 +118,11 @@ HELP: -nrot HELP: ndip { $values { "n" integer } } -{ $description "A generalization of " { $link dip } " that can work " +{ $description "A generalization of " { $link dip } " that can work " "for any stack depth. The quotation will be called with a stack that " "has 'n' items removed first. The 'n' items are then put back on the " "stack. The quotation can consume and produce any number of items." -} +} { $examples { $example "USING: arrays generalizations kernel prettyprint ;" "1 2 [ dup ] 1 ndip 3array ." "{ 1 1 2 }" } { $example "USING: arrays generalizations kernel prettyprint ;" "1 2 3 [ drop ] 2 ndip 2array ." "{ 2 3 }" } @@ -136,10 +136,10 @@ HELP: ndip HELP: nkeep { $values { "n" integer } } -{ $description "A generalization of " { $link keep } " that can work " +{ $description "A generalization of " { $link keep } " that can work " "for any stack depth. The first " { $snippet "n" } " items after the quotation will be " "saved, the quotation called, and the items restored." -} +} { $examples { $example "USING: generalizations kernel prettyprint" @@ -159,7 +159,7 @@ HELP: nkeep HELP: ncurry { $values { "n" integer } } { $description "A generalization of " { $link curry } " that can work for any stack depth." -} +} { $examples "Some core words expressed in terms of " { $link ncurry } ":" { $table @@ -172,7 +172,7 @@ HELP: ncurry HELP: nwith { $values { "n" integer } } { $description "A generalization of " { $link with } " that can work for any stack depth." -} +} { $examples "Some core words expressed in terms of " { $link nwith } ":" { $table @@ -183,7 +183,7 @@ HELP: nwith HELP: napply { $values { "quot" quotation } { "n" integer } } { $description "A generalization of " { $link bi@ } " and " { $link tri@ } " that can work for any stack depth." -} +} { $examples "Some core words expressed in terms of " { $link napply } ":" { $table @@ -196,7 +196,7 @@ HELP: napply HELP: ncleave { $values { "quots" "a sequence of quotations" } { "n" integer } } { $description "A generalization of " { $link cleave } " and " { $link 2cleave } " that can work for any quotation arity." -} +} { $examples "Some core words expressed in terms of " { $link ncleave } ":" { $table diff --git a/basis/graphs/graphs-docs.factor b/basis/graphs/graphs-docs.factor index 45f7f81ae7..4aa42c6d11 100644 --- a/basis/graphs/graphs-docs.factor +++ b/basis/graphs/graphs-docs.factor @@ -23,7 +23,7 @@ HELP: add-vertex HELP: remove-vertex { $values { "vertex" object } { "edges" sequence } { "graph" "an assoc mapping vertices to sequences of edges" } } -{ $description "Removes a vertex from a graph, using the given edges sequence." } +{ $description "Removes a vertex from a graph, using the given edges sequence." } { $notes "The " { $snippet "edges" } " sequence must equal the value passed to " { $link add-vertex } ", otherwise some vertices of the graph may continue to refer to the removed vertex." } { $side-effects "graph" } ; diff --git a/basis/help/apropos/apropos-docs.factor b/basis/help/apropos/apropos-docs.factor index 4d774a75cb..5d78e75e5a 100644 --- a/basis/help/apropos/apropos-docs.factor +++ b/basis/help/apropos/apropos-docs.factor @@ -5,4 +5,4 @@ HELP: apropos { $values { "str" string } } { $description "Lists all words, vocabularies and help articles whose name contains a subsequence equal to " { $snippet "str" } ". Results are ranked using a simple distance algorithm." } ; -TIP: "Use " { $link apropos } " to search for words, vocabularies and help articles." ; \ No newline at end of file +TIP: "Use " { $link apropos } " to search for words, vocabularies and help articles." ; diff --git a/basis/help/vocabs/vocabs-docs.factor b/basis/help/vocabs/vocabs-docs.factor index bc495586f5..91a3efd8b0 100644 --- a/basis/help/vocabs/vocabs-docs.factor +++ b/basis/help/vocabs/vocabs-docs.factor @@ -37,4 +37,4 @@ ARTICLE: "browsing-help" "Browsing documentation" { $code "\"evaluator\" help" } { $code "\\ + help" } { $code "\"io.files\" about" } -} ; \ No newline at end of file +} ; diff --git a/basis/html/templates/chloe/chloe-docs.factor b/basis/html/templates/chloe/chloe-docs.factor index 8ec925fc7d..0ad6ff7fd6 100644 --- a/basis/html/templates/chloe/chloe-docs.factor +++ b/basis/html/templates/chloe/chloe-docs.factor @@ -77,7 +77,7 @@ ARTICLE: "html.templates.chloe.tags.component" "Component Chloe tags" { { $snippet "t:link" } { $link link } } { { $snippet "t:password" } { $link password } } { { $snippet "t:textarea" } { $link textarea } } -} ; +} ; ARTICLE: "html.templates.chloe.tags.boilerplate" "Boilerplate Chloe tags" "The following Chloe tags interface with the HTML templating " { $link "html.templates.boilerplate" } "." diff --git a/basis/http/server/rewrite/rewrite-docs.factor b/basis/http/server/rewrite/rewrite-docs.factor index 2834e17d50..501d90848a 100644 --- a/basis/http/server/rewrite/rewrite-docs.factor +++ b/basis/http/server/rewrite/rewrite-docs.factor @@ -73,4 +73,4 @@ ARTICLE: "http.server.rewrite" "URL rewrite responders" } ; -ABOUT: "http.server.rewrite" \ No newline at end of file +ABOUT: "http.server.rewrite" diff --git a/basis/inspector/inspector-docs.factor b/basis/inspector/inspector-docs.factor index c3e9482020..4ed5fdf5c9 100644 --- a/basis/inspector/inspector-docs.factor +++ b/basis/inspector/inspector-docs.factor @@ -35,7 +35,7 @@ HELP: inspector-stack { $var-description "If the inspector is running, this variable holds previously-inspected objects." } ; HELP: &push -{ $values { "obj" object } } +{ $values { "obj" object } } { $description "If the inspector is running, outputs the object currently being inspected." } ; HELP: inspector diff --git a/basis/io/directories/hierarchy/hierarchy-docs.factor b/basis/io/directories/hierarchy/hierarchy-docs.factor index 232cad1291..cbe3260a2c 100644 --- a/basis/io/directories/hierarchy/hierarchy-docs.factor +++ b/basis/io/directories/hierarchy/hierarchy-docs.factor @@ -12,7 +12,7 @@ HELP: with-directory-tree-files HELP: delete-tree { $values { "path" "a pathname string" } } { $description "Deletes a file or directory, recursing into subdirectories." } -{ $errors "Throws an error if the deletion fails." } +{ $errors "Throws an error if the deletion fails." } { $warning "Misuse of this word can lead to catastrophic data loss." } ; HELP: copy-tree diff --git a/basis/io/encodings/8-bit/arabic/arabic-docs.factor b/basis/io/encodings/8-bit/arabic/arabic-docs.factor index 5c86326121..fe6374cbf4 100644 --- a/basis/io/encodings/8-bit/arabic/arabic-docs.factor +++ b/basis/io/encodings/8-bit/arabic/arabic-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.arabic HELP: latin/arabic -{ $var-description "This is the ISO-8859-6 encoding, also called Latin/Arabic. It is an 8-bit superset of ASCII and provides the characters necessary for Arabic, though not other languages which use Arabic script." } +{ $var-description "This is the ISO-8859-6 encoding, also called Latin/Arabic. It is an 8-bit superset of ASCII and provides the characters necessary for Arabic, though not other languages which use Arabic script." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.arabic" "Arabic encoding" diff --git a/basis/io/encodings/8-bit/cyrillic/cyrillic-docs.factor b/basis/io/encodings/8-bit/cyrillic/cyrillic-docs.factor index 741f1de1f6..6524faaab0 100644 --- a/basis/io/encodings/8-bit/cyrillic/cyrillic-docs.factor +++ b/basis/io/encodings/8-bit/cyrillic/cyrillic-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.cyrillic HELP: latin/cyrillic -{ $var-description "This is the ISO-8859-5 encoding, also called Latin/Cyrillic. It is an 8-bit superset of ASCII and provides the characters necessary for most languages which use Cyrilic, including Russian, Macedonian, Belarusian, Bulgarian, Serbian, and Ukrainian. KOI8-R is used much more commonly." } +{ $var-description "This is the ISO-8859-5 encoding, also called Latin/Cyrillic. It is an 8-bit superset of ASCII and provides the characters necessary for most languages which use Cyrilic, including Russian, Macedonian, Belarusian, Bulgarian, Serbian, and Ukrainian. KOI8-R is used much more commonly." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.cyrillic" "Cyrillic encoding" diff --git a/basis/io/encodings/8-bit/ebcdic/ebcdic-docs.factor b/basis/io/encodings/8-bit/ebcdic/ebcdic-docs.factor index 09646fddc3..d2dd101650 100644 --- a/basis/io/encodings/8-bit/ebcdic/ebcdic-docs.factor +++ b/basis/io/encodings/8-bit/ebcdic/ebcdic-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.ebcdic HELP: ebcdic -{ $var-description "EBCDIC is an 8-bit legacy encoding designed for IBM mainframes like System/360 in the 1960s. It has since fallen into disuse. It contains large unallocated regions, and the version included here (code page 37) contains auxiliary characters in this region for English- and Portugese-speaking countries." } +{ $var-description "EBCDIC is an 8-bit legacy encoding designed for IBM mainframes like System/360 in the 1960s. It has since fallen into disuse. It contains large unallocated regions, and the version included here (code page 37) contains auxiliary characters in this region for English- and Portugese-speaking countries." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.ebcdic" "EBCDIC encoding" diff --git a/basis/io/encodings/8-bit/greek/greek-docs.factor b/basis/io/encodings/8-bit/greek/greek-docs.factor index b7d658ac70..edf87e48d8 100644 --- a/basis/io/encodings/8-bit/greek/greek-docs.factor +++ b/basis/io/encodings/8-bit/greek/greek-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.greek HELP: latin/greek -{ $description "This is the ISO-8859-7 encoding, also called Latin/Greek. It is an 8-bit superset of ASCII and provides the characters necessary for Greek written in modern monotonic orthography, or ancient Greek without accent marks." } +{ $description "This is the ISO-8859-7 encoding, also called Latin/Greek. It is an 8-bit superset of ASCII and provides the characters necessary for Greek written in modern monotonic orthography, or ancient Greek without accent marks." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.greek" "Greek encoding" diff --git a/basis/io/encodings/8-bit/koi8-r/koi8-r-docs.factor b/basis/io/encodings/8-bit/koi8-r/koi8-r-docs.factor index 94e2652e2a..d63d37771d 100644 --- a/basis/io/encodings/8-bit/koi8-r/koi8-r-docs.factor +++ b/basis/io/encodings/8-bit/koi8-r/koi8-r-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.koi8-r HELP: koi8-r -{ $var-description "KOI8-R is an 8-bit superset of ASCII which encodes the Cyrillic alphabet, as used in Russian and Bulgarian. Characters are in such an order that, if the eight bit is stripped, text is still interpretable as ASCII. Block-building characters also exist." } +{ $var-description "KOI8-R is an 8-bit superset of ASCII which encodes the Cyrillic alphabet, as used in Russian and Bulgarian. Characters are in such an order that, if the eight bit is stripped, text is still interpretable as ASCII. Block-building characters also exist." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.koi8-r" "KOI8-R encoding" diff --git a/basis/io/encodings/8-bit/latin1/latin1-docs.factor b/basis/io/encodings/8-bit/latin1/latin1-docs.factor index 90bc0125a9..a5c9bd7619 100644 --- a/basis/io/encodings/8-bit/latin1/latin1-docs.factor +++ b/basis/io/encodings/8-bit/latin1/latin1-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.latin1 HELP: latin1 -{ $var-description "This is the ISO-8859-1 encoding, also called Latin-1: Western European. It is an 8-bit superset of ASCII which is the default for a mimetype starting with 'text' and provides the characters necessary for most western European languages." } +{ $var-description "This is the ISO-8859-1 encoding, also called Latin-1: Western European. It is an 8-bit superset of ASCII which is the default for a mimetype starting with 'text' and provides the characters necessary for most western European languages." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.latin1" "Latin1 encoding" diff --git a/basis/io/encodings/8-bit/latin10/latin10-docs.factor b/basis/io/encodings/8-bit/latin10/latin10-docs.factor index 382b083a26..da06009e57 100644 --- a/basis/io/encodings/8-bit/latin10/latin10-docs.factor +++ b/basis/io/encodings/8-bit/latin10/latin10-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.latin10 HELP: latin10 -{ $var-description "This is the ISO-8859-16 encoding, also called Latin-10: South-Eastern European. It is an 8-bit superset of ASCII." } +{ $var-description "This is the ISO-8859-16 encoding, also called Latin-10: South-Eastern European. It is an 8-bit superset of ASCII." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.latin10" "Latin10 encoding" diff --git a/basis/io/encodings/8-bit/latin2/latin2-docs.factor b/basis/io/encodings/8-bit/latin2/latin2-docs.factor index 1da488fe6c..c2ee8fcfaf 100644 --- a/basis/io/encodings/8-bit/latin2/latin2-docs.factor +++ b/basis/io/encodings/8-bit/latin2/latin2-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.latin2 HELP: latin2 -{ $var-description "This is the ISO-8859-2 encoding, also called Latin-2: Eastern European. It is an 8-bit superset of ASCII and provides the characters necessary for most eastern European languages." } +{ $var-description "This is the ISO-8859-2 encoding, also called Latin-2: Eastern European. It is an 8-bit superset of ASCII and provides the characters necessary for most eastern European languages." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.latin2" "Latin2 encoding" diff --git a/basis/io/encodings/8-bit/latin3/latin3-docs.factor b/basis/io/encodings/8-bit/latin3/latin3-docs.factor index 8cb719b890..6613e2ed04 100644 --- a/basis/io/encodings/8-bit/latin3/latin3-docs.factor +++ b/basis/io/encodings/8-bit/latin3/latin3-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.latin3 HELP: latin3 -{ $var-description "This is the ISO-8859-3 encoding, also called Latin-3: South European. It is an 8-bit superset of ASCII and provides the characters necessary for Turkish, Maltese and Esperanto." } +{ $var-description "This is the ISO-8859-3 encoding, also called Latin-3: South European. It is an 8-bit superset of ASCII and provides the characters necessary for Turkish, Maltese and Esperanto." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.latin3" "Latin3 encoding" diff --git a/basis/io/encodings/8-bit/latin4/latin4-docs.factor b/basis/io/encodings/8-bit/latin4/latin4-docs.factor index cfb53d23b6..5e1c8a2eaf 100644 --- a/basis/io/encodings/8-bit/latin4/latin4-docs.factor +++ b/basis/io/encodings/8-bit/latin4/latin4-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.latin4 HELP: latin4 -{ $description "This is the ISO-8859-4 encoding, also called Latin-4: North European. It is an 8-bit superset of ASCII and provides the characters necessary for Latvian, Lithuanian, Estonian, Greenlandic and Sami." } +{ $description "This is the ISO-8859-4 encoding, also called Latin-4: North European. It is an 8-bit superset of ASCII and provides the characters necessary for Latvian, Lithuanian, Estonian, Greenlandic and Sami." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.latin4" "Latin4 encoding" diff --git a/basis/io/encodings/8-bit/latin5/latin5-docs.factor b/basis/io/encodings/8-bit/latin5/latin5-docs.factor index 60feed181c..c144638be7 100644 --- a/basis/io/encodings/8-bit/latin5/latin5-docs.factor +++ b/basis/io/encodings/8-bit/latin5/latin5-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.latin5 HELP: latin5 -{ $var-description "This is the ISO-8859-9 encoding, also called Latin-5: Turkish. It is an 8-bit superset of ASCII and provides the characters necessary for Turkish, similar to Latin-1 but replacing the spots used for Icelandic with characters used in Turkish." } +{ $var-description "This is the ISO-8859-9 encoding, also called Latin-5: Turkish. It is an 8-bit superset of ASCII and provides the characters necessary for Turkish, similar to Latin-1 but replacing the spots used for Icelandic with characters used in Turkish." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.latin5" "Latin5 encoding" diff --git a/basis/io/encodings/8-bit/latin6/latin6-docs.factor b/basis/io/encodings/8-bit/latin6/latin6-docs.factor index f1866c3ec1..a33788bc22 100644 --- a/basis/io/encodings/8-bit/latin6/latin6-docs.factor +++ b/basis/io/encodings/8-bit/latin6/latin6-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.latin6 HELP: latin6 -{ $var-description "This is the ISO-8859-10 encoding, also called Latin-6: Nordic. It is an 8-bit superset of ASCII containing the same characters as Latin-4, but rearranged to be of better use to nordic languages." } +{ $var-description "This is the ISO-8859-10 encoding, also called Latin-6: Nordic. It is an 8-bit superset of ASCII containing the same characters as Latin-4, but rearranged to be of better use to nordic languages." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.latin6" "Latin6 encoding" diff --git a/basis/io/encodings/8-bit/latin7/latin7-docs.factor b/basis/io/encodings/8-bit/latin7/latin7-docs.factor index ebd5eb6d97..c4e3b80638 100644 --- a/basis/io/encodings/8-bit/latin7/latin7-docs.factor +++ b/basis/io/encodings/8-bit/latin7/latin7-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.latin7 HELP: latin7 -{ $var-description "This is the ISO-8859-13 encoding, also called Latin-7: Baltic Rim. It is an 8-bit superset of ASCII containing all characters necessary to represent Baltic Rim languages, as previous character sets were incomplete." } +{ $var-description "This is the ISO-8859-13 encoding, also called Latin-7: Baltic Rim. It is an 8-bit superset of ASCII containing all characters necessary to represent Baltic Rim languages, as previous character sets were incomplete." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.latin7" "Latin7 encoding" diff --git a/basis/io/encodings/8-bit/latin8/latin8-docs.factor b/basis/io/encodings/8-bit/latin8/latin8-docs.factor index 5dc2f1e45d..f72bf4f9ce 100644 --- a/basis/io/encodings/8-bit/latin8/latin8-docs.factor +++ b/basis/io/encodings/8-bit/latin8/latin8-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.latin8 HELP: latin8 -{ $var-description "This is the ISO-8859-14 encoding, also called Latin-8: Celtic. It is an 8-bit superset of ASCII designed for Celtic languages like Gaelic and Breton." } +{ $var-description "This is the ISO-8859-14 encoding, also called Latin-8: Celtic. It is an 8-bit superset of ASCII designed for Celtic languages like Gaelic and Breton." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.latin8" "Latin8 encoding" diff --git a/basis/io/encodings/8-bit/mac-roman/mac-roman-docs.factor b/basis/io/encodings/8-bit/mac-roman/mac-roman-docs.factor index 3fd00fa8a3..1fd061ac68 100644 --- a/basis/io/encodings/8-bit/mac-roman/mac-roman-docs.factor +++ b/basis/io/encodings/8-bit/mac-roman/mac-roman-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.mac-roman HELP: mac-roman -{ $var-description "Mac Roman is an 8-bit superset of ASCII which was the standard encoding on Mac OS prior to version 10. It is incompatible with Latin-1 in all but a few places and ASCII, and it is suitable for encoding many Western European languages." } +{ $var-description "Mac Roman is an 8-bit superset of ASCII which was the standard encoding on Mac OS prior to version 10. It is incompatible with Latin-1 in all but a few places and ASCII, and it is suitable for encoding many Western European languages." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.mac-roman" "Mac Roman encoding" diff --git a/basis/io/encodings/8-bit/thai/thai-docs.factor b/basis/io/encodings/8-bit/thai/thai-docs.factor index 5d2640b6fd..c9a5294a41 100644 --- a/basis/io/encodings/8-bit/thai/thai-docs.factor +++ b/basis/io/encodings/8-bit/thai/thai-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.thai HELP: latin/thai -{ $var-description "This is the ISO-8859-11 encoding, also called Latin/Thai. It is an 8-bit superset of ASCII containing the characters necessary to represent Thai. It is basically identical to TIS-620." } +{ $var-description "This is the ISO-8859-11 encoding, also called Latin/Thai. It is an 8-bit superset of ASCII containing the characters necessary to represent Thai. It is basically identical to TIS-620." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.thai" "Thai encoding" diff --git a/basis/io/encodings/8-bit/windows-1252/windows-1252-docs.factor b/basis/io/encodings/8-bit/windows-1252/windows-1252-docs.factor index cd9461e19d..ed5e480849 100644 --- a/basis/io/encodings/8-bit/windows-1252/windows-1252-docs.factor +++ b/basis/io/encodings/8-bit/windows-1252/windows-1252-docs.factor @@ -4,7 +4,7 @@ USING: help.markup help.syntax ; IN: io.encodings.8-bit.windows-1252 HELP: windows-1252 -{ $var-description "Windows 1252 is an 8-bit superset of ASCII which is closely related to Latin-1. Control characters in the 0x80 to 0x9F range are replaced with printable characters such as the Euro symbol." } +{ $var-description "Windows 1252 is an 8-bit superset of ASCII which is closely related to Latin-1. Control characters in the 0x80 to 0x9F range are replaced with printable characters such as the Euro symbol." } { $see-also "encodings-introduction" } ; ARTICLE: "io.encodings.8-bit.windows-1252" "Windows 1252 encoding" diff --git a/basis/io/encodings/binary/binary-docs.factor b/basis/io/encodings/binary/binary-docs.factor index 14908c3903..5e14518361 100644 --- a/basis/io/encodings/binary/binary-docs.factor +++ b/basis/io/encodings/binary/binary-docs.factor @@ -5,7 +5,7 @@ HELP: binary { $class-description "Encoding descriptor for binary I/O." } ; ARTICLE: "io.encodings.binary" "Binary encoding" -"Making an encoded stream with the binary encoding is a no-op; streams with this encoding deal with byte-arrays, not strings." +"Making an encoded stream with the binary encoding is a no-op; streams with this encoding deal with byte-arrays, not strings." { $subsections binary } ; ABOUT: "io.encodings.binary" diff --git a/basis/io/encodings/euc-kr/euc-kr-docs.factor b/basis/io/encodings/euc-kr/euc-kr-docs.factor index 2abe804a56..7b2248af05 100644 --- a/basis/io/encodings/euc-kr/euc-kr-docs.factor +++ b/basis/io/encodings/euc-kr/euc-kr-docs.factor @@ -10,4 +10,4 @@ HELP: euc-kr ARTICLE: "io.encodings.euc-kr" "EUC-KR encoding" { $subsections euc-kr } ; -ABOUT: "io.encodings.euc-kr" \ No newline at end of file +ABOUT: "io.encodings.euc-kr" diff --git a/basis/io/encodings/iana/iana-docs.factor b/basis/io/encodings/iana/iana-docs.factor index d6ce4fb2fb..f4d78a217d 100644 --- a/basis/io/encodings/iana/iana-docs.factor +++ b/basis/io/encodings/iana/iana-docs.factor @@ -5,7 +5,7 @@ ABOUT: "io.encodings.iana" ARTICLE: "io.encodings.iana" "IANA-registered encoding names" "The " { $vocab-link "io.encodings.iana" } " vocabulary provides words for accessing the names of encodings and the encoding descriptors corresponding to names." $nl -"Most text encodings in common use have been registered with IANA. There is a standard set of names for each encoding. Simple conversion functions:" +"Most text encodings in common use have been registered with IANA. There is a standard set of names for each encoding. Simple conversion functions:" { $subsections name>encoding encoding>name diff --git a/basis/io/encodings/johab/johab-docs.factor b/basis/io/encodings/johab/johab-docs.factor index c94f464354..67fc0c1a32 100644 --- a/basis/io/encodings/johab/johab-docs.factor +++ b/basis/io/encodings/johab/johab-docs.factor @@ -9,4 +9,4 @@ HELP: johab ARTICLE: "io.encodings.johab" "Korean Johab encoding" { $subsections johab } ; -ABOUT: "io.encodings.johab" \ No newline at end of file +ABOUT: "io.encodings.johab" diff --git a/basis/io/encodings/string/string-docs.factor b/basis/io/encodings/string/string-docs.factor index 9d50267395..8dce520ddb 100644 --- a/basis/io/encodings/string/string-docs.factor +++ b/basis/io/encodings/string/string-docs.factor @@ -23,7 +23,7 @@ B{ 230 136 145 231 136 177 228 189 160 } utf8 decode .""" } } ; -HELP: encode +HELP: encode { $values { "string" string } { "encoding" "an encoding descriptor" } { "byte-array" byte-array } } { $description "Converts a string into a byte array, interpreting that string with the given encoding." } { $examples diff --git a/basis/io/encodings/utf32/utf32-docs.factor b/basis/io/encodings/utf32/utf32-docs.factor index 933218012d..53bba09861 100644 --- a/basis/io/encodings/utf32/utf32-docs.factor +++ b/basis/io/encodings/utf32/utf32-docs.factor @@ -26,4 +26,3 @@ HELP: utf32 { $see-also "encodings-introduction" } ; { utf32 utf32le utf32be } related-words - diff --git a/basis/io/ports/ports-docs.factor b/basis/io/ports/ports-docs.factor index d7f23c8be0..c32ebbd186 100644 --- a/basis/io/ports/ports-docs.factor +++ b/basis/io/ports/ports-docs.factor @@ -54,17 +54,17 @@ $low-level-note ; HELP: { $values { "handle" "a native handle identifying an I/O resource" } { "class" class } { "port" "a new " { $link port } } } -{ $description "Creates a new " { $link port } " using the specified native handle and a default-sized I/O buffer." } +{ $description "Creates a new " { $link port } " using the specified native handle and a default-sized I/O buffer." } $low-level-note ; HELP: { $values { "handle" "a native handle identifying an I/O resource" } { "input-port" "a new " { $link input-port } } } -{ $description "Creates a new " { $link input-port } " using the specified native handle and a default-sized input buffer." } +{ $description "Creates a new " { $link input-port } " using the specified native handle and a default-sized input buffer." } $low-level-note ; HELP: { $values { "handle" "a native handle identifying an I/O resource" } { "output-port" "a new " { $link output-port } } } -{ $description "Creates a new " { $link output-port } " using the specified native handle and a default-sized input buffer." } +{ $description "Creates a new " { $link output-port } " using the specified native handle and a default-sized input buffer." } $low-level-note ; HELP: (wait-to-read) diff --git a/basis/io/sockets/icmp/icmp-docs.factor b/basis/io/sockets/icmp/icmp-docs.factor index b06aca98ac..d9378cceda 100644 --- a/basis/io/sockets/icmp/icmp-docs.factor +++ b/basis/io/sockets/icmp/icmp-docs.factor @@ -82,4 +82,3 @@ ARTICLE: "network-icmp" "ICMP" } ; ABOUT: "network-icmp" - diff --git a/basis/io/streams/null/null-docs.factor b/basis/io/streams/null/null-docs.factor index e78f3df28d..8d68085b4f 100644 --- a/basis/io/streams/null/null-docs.factor +++ b/basis/io/streams/null/null-docs.factor @@ -29,4 +29,4 @@ $nl with-null-reader } ; -ABOUT: "io.streams.null" \ No newline at end of file +ABOUT: "io.streams.null" diff --git a/basis/io/streams/throwing/throwing-docs.factor b/basis/io/streams/throwing/throwing-docs.factor index 14ceb6c790..4983c014f7 100644 --- a/basis/io/streams/throwing/throwing-docs.factor +++ b/basis/io/streams/throwing/throwing-docs.factor @@ -6,13 +6,13 @@ IN: io.streams.throwing HELP: stream-exhausted { $values - { "n" integer } { "stream" "an input stream" } { "word" word } + { "n" integer } { "stream" "an input stream" } { "word" word } } { $description "The exception that gets thrown when a stream is exhausted." } ; HELP: stream-throw-on-eof { $values - { "stream" "an input stream" } { "quot" quotation } + { "stream" "an input stream" } { "quot" quotation } } { $description "Wraps a stream in a " { $link } " tuple and calls the quotation with this stream as the " { $link input-stream } " variable. Causes a " { $link stream-exhausted } " exception to be thrown upon stream exhaustion. The stream is left open after this combinator returns." } "This example will throw a " { $link stream-exhausted } " exception:" diff --git a/basis/json/writer/writer-docs.factor b/basis/json/writer/writer-docs.factor index 6d441cfc57..9c8d0d5b93 100644 --- a/basis/json/writer/writer-docs.factor +++ b/basis/json/writer/writer-docs.factor @@ -5,7 +5,7 @@ IN: json.writer HELP: >json { $values { "obj" object } { "string" "the object converted to JSON format" } } -{ $description "Serializes the object into a JSON formatted string." } +{ $description "Serializes the object into a JSON formatted string." } { $see-also json-print } ; HELP: json-print diff --git a/basis/linked-assocs/linked-assocs-docs.factor b/basis/linked-assocs/linked-assocs-docs.factor index f8455cce9f..2e9ce0169d 100644 --- a/basis/linked-assocs/linked-assocs-docs.factor +++ b/basis/linked-assocs/linked-assocs-docs.factor @@ -22,4 +22,4 @@ $nl } ; -ABOUT: "linked-assocs" \ No newline at end of file +ABOUT: "linked-assocs" diff --git a/basis/match/match-docs.factor b/basis/match/match-docs.factor index fb73182f3d..e6d61297cc 100644 --- a/basis/match/match-docs.factor +++ b/basis/match/match-docs.factor @@ -4,19 +4,19 @@ USING: help.markup help.syntax namespaces assocs sequences kernel combinators ; IN: match -HELP: match +HELP: match { $values { "value1" object } { "value2" object } { "bindings" assoc } } -{ $description "Pattern match value1 against value2. These values can be any Factor value, including sequences and tuples. The values can contain pattern variables, which are symbols that begin with '?'. The result is a hashtable of the bindings, mapping the pattern variables from one sequence to the equivalent value in the other sequence. The '_' symbol can be used to ignore the value at that point in the pattern for the match. " } -{ $examples +{ $description "Pattern match value1 against value2. These values can be any Factor value, including sequences and tuples. The values can contain pattern variables, which are symbols that begin with '?'. The result is a hashtable of the bindings, mapping the pattern variables from one sequence to the equivalent value in the other sequence. The '_' symbol can be used to ignore the value at that point in the pattern for the match. " } +{ $examples { $unchecked-example "USE: match" "MATCH-VARS: ?a ?b ;\n{ ?a { 2 ?b } 5 } { 1 { 2 3 } _ } match ." "H{ { ?a 1 } { ?b 3 } }" } } { $see-also match-cond POSTPONE: MATCH-VARS: replace-patterns match-replace } ; HELP: match-cond { $values { "assoc" "a sequence of pairs" } } -{ $description "Calls the second quotation in the first pair whose first sequence yields a successful " { $link match } " against the top of the stack. The second quotation, when called, has the hashtable returned from the " { $link match } " call bound as the top namespace so " { $link get } " can be used to retrieve the values. To have a fallthrough match clause use the '_' match variable." } -{ $examples +{ $description "Calls the second quotation in the first pair whose first sequence yields a successful " { $link match } " against the top of the stack. The second quotation, when called, has the hashtable returned from the " { $link match } " call bound as the top namespace so " { $link get } " can be used to retrieve the values. To have a fallthrough match clause use the '_' match variable." } +{ $examples { $code "USE: match" "MATCH-VARS: ?value ;\n{ increment 346126 } {\n { { increment ?value } [ ?value do-something ] }\n { { decrement ?value } [ ?value do-something-else ] }\n { _ [ no-match-found ] }\n} match-cond" } } { $see-also match POSTPONE: MATCH-VARS: replace-patterns match-replace } ; @@ -26,25 +26,25 @@ HELP: MATCH-VARS: { $syntax "MATCH-VARS: var ... ;" } { $values { "var" "a match variable name beginning with '?'" } } { $description "Creates a symbol that can be used in " { $link match } " and " { $link match-cond } " for binding values in the matched sequence. The symbol name is created as a word that is defined to get the value of the symbol out of the current namespace. This can be used in " { $link match-cond } " to retrive the values in the quotation body." } -{ $examples +{ $examples { $code "USE: match" "MATCH-VARS: ?value ;\n{ increment 346126 } {\n { { increment ?value } [ ?value do-something ] }\n { { decrement ?value } [ ?value do-something-else ] }\n { _ [ no-match-found ] }\n} match-cond" } } { $see-also match match-cond replace-patterns match-replace } ; HELP: replace-patterns { $values { "object" object } { "result" object } } -{ $description "Copy the object, replacing each occurrence of a pattern matching variable with the actual value of that variable." } +{ $description "Copy the object, replacing each occurrence of a pattern matching variable with the actual value of that variable." } { $see-also match-cond POSTPONE: MATCH-VARS: match-replace } ; HELP: match-replace { $values { "object" object } { "pattern1" object } { "pattern2" object } { "result" object } } -{ $description "Matches the " { $snippet "object" } " against " { $snippet "pattern1" } ". The pattern match variables in " { $snippet "pattern1" } " are assigned the values from the matching " { $snippet "object" } ". These are then replaced into the " { $snippet "pattern2" } " pattern match variables." } +{ $description "Matches the " { $snippet "object" } " against " { $snippet "pattern1" } ". The pattern match variables in " { $snippet "pattern1" } " are assigned the values from the matching " { $snippet "object" } ". These are then replaced into the " { $snippet "pattern2" } " pattern match variables." } { $examples { $example "USING: match prettyprint ;" "IN: scratchpad" "MATCH-VARS: ?a ?b ;" - "{ 1 2 } { ?a ?b } { ?b ?a } match-replace ." + "{ 1 2 } { ?a ?b } { ?b ?a } match-replace ." "{ 2 1 }" } } diff --git a/basis/math/quaternions/quaternions-docs.factor b/basis/math/quaternions/quaternions-docs.factor index d3bead7dea..0a35ab12f3 100644 --- a/basis/math/quaternions/quaternions-docs.factor +++ b/basis/math/quaternions/quaternions-docs.factor @@ -42,4 +42,3 @@ HELP: c>q HELP: euler { $values { "phi" number } { "theta" number } { "psi" number } { "q" "a quaternion" } } { $description "Convert a rotation given by Euler angles (phi, theta, and psi) to a quaternion." } ; - diff --git a/basis/math/ranges/ranges-docs.factor b/basis/math/ranges/ranges-docs.factor index 1c82f516c9..e0ce98f1de 100644 --- a/basis/math/ranges/ranges-docs.factor +++ b/basis/math/ranges/ranges-docs.factor @@ -24,5 +24,5 @@ $nl "Computing the factorial of 100 with a descending range:" { $code "100 1 [a,b] product" } "A range can be converted into a concrete sequence using a word such as " { $link >array } ". In most cases this is unnecessary since ranges implement the sequence protocol already. It is necessary if a mutable sequence is needed, for use with words such as " { $link set-nth } " or " { $link map! } "." ; - + ABOUT: "math.ranges" diff --git a/basis/math/ratios/ratios-docs.factor b/basis/math/ratios/ratios-docs.factor index 6c3fca6061..57b37f1bb7 100644 --- a/basis/math/ratios/ratios-docs.factor +++ b/basis/math/ratios/ratios-docs.factor @@ -48,4 +48,3 @@ HELP: >fraction HELP: 2>fraction { $values { "a/b" rational } { "c/d" rational } { "a" integer } { "c" integer } { "b" "a positive integer" } { "d" "a positive integer" } } { $description "Extracts the numerator and denominator of two rational numbers at once." } ; - diff --git a/basis/math/statistics/statistics-docs.factor b/basis/math/statistics/statistics-docs.factor index 5315927910..959bea8d09 100644 --- a/basis/math/statistics/statistics-docs.factor +++ b/basis/math/statistics/statistics-docs.factor @@ -73,7 +73,7 @@ HELP: sample-var { $example "USING: math.statistics prettyprint ;" "{ 1 2 3 } sample-var ." "1" } { $example "USING: math.statistics prettyprint ;" "{ 1 2 3 4 } sample-var ." "1+2/3" } } ; -HELP: population-cov +HELP: population-cov { $values { "{x}" sequence } { "{y}" sequence } { "cov" "a real number" } } { $description "Computes the covariance of two sequences, " { $snippet "{x}" } " and " { $snippet "{y}" } "." } ; diff --git a/basis/mime/types/types-docs.factor b/basis/mime/types/types-docs.factor index 4368207c85..26a139b195 100644 --- a/basis/mime/types/types-docs.factor +++ b/basis/mime/types/types-docs.factor @@ -5,7 +5,7 @@ IN: mime.types HELP: mime-db { $values - + { "seq" sequence } } { $description "Outputs an array where the first element is a MIME type and the rest of the array is file extensions that have that MIME type." } ; @@ -17,13 +17,13 @@ HELP: mime-type HELP: mime-types { $values - + { "assoc" assoc } } { $description "Outputs an " { $snippet "assoc" } " made from the data in the " { $link mime-db } " word where the keys are file extensions and the values are the corresponding MIME types." } ; HELP: nonstandard-mime-types { $values - + { "assoc" assoc } } { $description "A list of Factor-specific MIME types that are added to the MIME database loaded from disk." } ; diff --git a/basis/mirrors/mirrors-docs.factor b/basis/mirrors/mirrors-docs.factor index 13f0d8bb49..e4487111b9 100644 --- a/basis/mirrors/mirrors-docs.factor +++ b/basis/mirrors/mirrors-docs.factor @@ -23,7 +23,7 @@ $nl "Mirrors are created by calling " { $link } " or " { $link make-mirror } "." } ; HELP: -{ $values { "object" object } { "mirror" mirror } } +{ $values { "object" object } { "mirror" mirror } } { $description "Creates a " { $link mirror } " reflecting an object." } { $examples { $example diff --git a/basis/models/models-docs.factor b/basis/models/models-docs.factor index aa0a8f3b87..3e4e527c08 100644 --- a/basis/models/models-docs.factor +++ b/basis/models/models-docs.factor @@ -113,17 +113,17 @@ HELP: range-max-value* HELP: set-range-value { $values { "value" object } { "model" model } } -{ $description "Sets the current value of a range model." } +{ $description "Sets the current value of a range model." } { $side-effects "model" } ; HELP: set-range-page-value { $values { "value" object } { "model" model } } -{ $description "Sets the page size of a range model." } +{ $description "Sets the page size of a range model." } { $side-effects "model" } ; HELP: set-range-min-value { $values { "value" object } { "model" model } } -{ $description "Sets the minimum value of a range model." } +{ $description "Sets the minimum value of a range model." } { $side-effects "model" } ; HELP: set-range-max-value diff --git a/basis/models/range/range-docs.factor b/basis/models/range/range-docs.factor index dc3cc35e87..b04aab369a 100644 --- a/basis/models/range/range-docs.factor +++ b/basis/models/range/range-docs.factor @@ -59,8 +59,8 @@ ARTICLE: "range-model-protocol" "Range model protocol" range-max-value* set-range-value set-range-page-value - set-range-min-value - set-range-max-value + set-range-min-value + set-range-max-value } ; ABOUT: "models-range" diff --git a/basis/opengl/annotations/annotations-docs.factor b/basis/opengl/annotations/annotations-docs.factor index c05ee17c47..d6a73bf83f 100644 --- a/basis/opengl/annotations/annotations-docs.factor +++ b/basis/opengl/annotations/annotations-docs.factor @@ -40,4 +40,4 @@ ARTICLE: "opengl.annotations" "OpenGL error reporting" reset-gl-functions } ; -ABOUT: "opengl.annotations" \ No newline at end of file +ABOUT: "opengl.annotations" diff --git a/basis/opengl/gl/gl-docs.factor b/basis/opengl/gl/gl-docs.factor index 019b29ef54..a94e52b9fc 100644 --- a/basis/opengl/gl/gl-docs.factor +++ b/basis/opengl/gl/gl-docs.factor @@ -87,5 +87,3 @@ ARTICLE: "opengl-modeling-transformations" "Modeling transformations" { glTranslatef glTranslated glRotatef glRotated glScalef glScaled } related-words - - diff --git a/basis/opengl/shaders/shaders-docs.factor b/basis/opengl/shaders/shaders-docs.factor index ac938f3a48..30a4cff0b6 100644 --- a/basis/opengl/shaders/shaders-docs.factor +++ b/basis/opengl/shaders/shaders-docs.factor @@ -69,7 +69,7 @@ HELP: gl-program } ; HELP: -{ $values { "shaders" "A sequence of " { $link gl-shader } " objects." } { "program" "a new " { $link gl-program } } } +{ $values { "shaders" "A sequence of " { $link gl-shader } " objects." } { "program" "a new " { $link gl-program } } } { $description "Creates a new GLSL program object, attaches all the shader objects in the " { $snippet "shaders" } " sequence, and attempts to link them. The returned object can be checked for validity by " { $link check-gl-program } " or " { $link gl-program-ok? } ". Errors and warnings generated by the GLSL linker will be collected in the info log, available from " { $link gl-program-info-log } ".\n\nWhen the program object and its attached shaders are no longer needed, it should be deleted using " { $link delete-gl-program } "." } ; HELP: diff --git a/basis/opengl/textures/textures-docs.factor b/basis/opengl/textures/textures-docs.factor index b209ee5cd5..47e33d73e5 100644 --- a/basis/opengl/textures/textures-docs.factor +++ b/basis/opengl/textures/textures-docs.factor @@ -12,4 +12,3 @@ HELP: delete-texture HELP: make-texture { $values { "image" image } { "id" "an OpenGL texture ID" } } { $description "Creates a new OpenGL texture from a pixmap image whose dimensions are equal to " { $snippet "dim" } "." } ; - \ No newline at end of file diff --git a/basis/peg/parsers/parsers-docs.factor b/basis/peg/parsers/parsers-docs.factor index 3eae7c776e..b389032fb2 100644 --- a/basis/peg/parsers/parsers-docs.factor +++ b/basis/peg/parsers/parsers-docs.factor @@ -173,7 +173,7 @@ HELP: range-pattern "of characters separated with a dash (-) represents the " "range of characters from the first to the second, inclusive." { $examples - { $example "USING: peg peg.parsers prettyprint strings ;" "\"a\" \"_a-zA-Z\" range-pattern parse 1string ." "\"a\"" } - { $code "USING: peg peg.parsers prettyprint ;\n\"0\" \"^0-9\" range-pattern parse => exception"} + { $example "USING: peg peg.parsers prettyprint strings ;" "\"a\" \"_a-zA-Z\" range-pattern parse 1string ." "\"a\"" } + { $code "USING: peg peg.parsers prettyprint ;\n\"0\" \"^0-9\" range-pattern parse => exception"} } } ; diff --git a/basis/peg/search/search-docs.factor b/basis/peg/search/search-docs.factor index 6762373744..bd6fa064c7 100644 --- a/basis/peg/search/search-docs.factor +++ b/basis/peg/search/search-docs.factor @@ -41,4 +41,3 @@ HELP: replace } { $example "USING: math math.parser peg peg.parsers peg.search prettyprint ;" "\"one 123 two 456\" 'integer' [ 2 * number>string ] action replace ." "\"one 246 two 912\"" } { $see-also search } ; - diff --git a/basis/promises/promises-docs.factor b/basis/promises/promises-docs.factor index 4bf309c238..9c26923114 100644 --- a/basis/promises/promises-docs.factor +++ b/basis/promises/promises-docs.factor @@ -14,7 +14,7 @@ HELP: force HELP: LAZY: { $syntax "LAZY: word ( stack -- effect ) definition... ;" } { $values { "word" "a new word to define" } { "definition" "a word definition" } } -{ $description "Creates a lazy word in the current vocabulary. When executed the word will return a " { $link promise } " that when forced, executes the word definition. Any values on the stack that are required by the word definition are captured along with the promise." } +{ $description "Creates a lazy word in the current vocabulary. When executed the word will return a " { $link promise } " that when forced, executes the word definition. Any values on the stack that are required by the word definition are captured along with the promise." } { $examples { $example "USING: arrays sequences prettyprint promises ;" "IN: scratchpad" "LAZY: zeroes ( -- pair ) 0 zeroes 2array ;" "zeroes force second force first ." "0" } } ; diff --git a/basis/random/random-docs.factor b/basis/random/random-docs.factor index 5a6598f035..efe9ce7872 100644 --- a/basis/random/random-docs.factor +++ b/basis/random/random-docs.factor @@ -39,7 +39,7 @@ HELP: random-32 HELP: random-bytes { $values { "n" integer } { "byte-array" "a random integer" } } { $description "Outputs an integer with n bytes worth of bits." } -{ $examples +{ $examples { $unchecked-example "USING: prettyprint random ;" "5 random-bytes ." "B{ 135 50 185 119 240 }" @@ -49,7 +49,7 @@ HELP: random-bytes HELP: random-integers { $values { "length" integer } { "n" integer } { "sequence" array } } { $description "Outputs an array with " { $snippet "length" } " random integers from [0,n)." } -{ $examples +{ $examples { $unchecked-example "USING: prettyprint random ;" "10 100 random-integers ." "{ 32 62 71 89 54 12 57 57 10 19 }" @@ -63,7 +63,7 @@ HELP: random-unit HELP: random-units { $values { "length" integer } { "sequence" array } } { $description "Outputs an array with " { $snippet "length" } " random uniform floats from [0,1]." } -{ $examples +{ $examples { $unchecked-example "USING: prettyprint random ;" "7 random-units ." "{ diff --git a/basis/refs/refs-docs.factor b/basis/refs/refs-docs.factor index 8fe7797627..92980e4703 100644 --- a/basis/refs/refs-docs.factor +++ b/basis/refs/refs-docs.factor @@ -94,7 +94,7 @@ HELP: var-ref HELP: { $values { "var" object } { "var-ref" var-ref } } { $description "Creates a reference to the given variable. Note that this reference behaves just like any variable when it comes to dynamic scope. For example, if you use " { $link set-ref } " in an inner scope and then leave that scope, then calling " { $link get-ref } " may not return the expected value. If this is not what you want, try using an " { $link obj-ref } " instead." } ; - + HELP: global-var-ref { $class-description "Instances of this class reference a global variable. New global references are created by calling " { $link } "." } ; @@ -108,7 +108,7 @@ HELP: slot-ref HELP: { $values { "tuple" tuple } { "slot" integer } { "slot-ref" slot-ref } } { $description "Creates a reference to the value in a particular slot of the given tuple. The slot must be given as an integer, where the first user-defined slot is number 2. This is mostly just a proof of concept until we have a way of generating this slot number from a slot name." } ; - + HELP: key-ref { $class-description "Instances of this class identify a key in an associative structure. New key references are created by calling " { $link } "." } ; @@ -124,7 +124,7 @@ HELP: { $description "Creates a reference to the value associated with " { $snippet "key" } " in " { $snippet "assoc" } "." } ; { get-ref set-ref delete-ref set-ref* } related-words - + { } related-words HELP: set-ref* @@ -150,7 +150,7 @@ HELP: ref-dec HELP: take { $values { "ref" ref } { "obj" object } } { $description "Retrieve the value of the ref and then delete it, returning the value." } ; - + { ref-on ref-off ref-inc ref-dec take } related-words { take delete-ref } related-words { on ref-on } related-words diff --git a/basis/roman/roman-docs.factor b/basis/roman/roman-docs.factor index c9c3db71b5..bb596c4345 100644 --- a/basis/roman/roman-docs.factor +++ b/basis/roman/roman-docs.factor @@ -7,7 +7,7 @@ HELP: >roman { $values { "n" integer } { "str" string } } { $description "Converts a number to its lower-case Roman Numeral equivalent." } { $notes "The range for this word is 1-3999, inclusive." } -{ $examples +{ $examples { $example "USING: io roman ;" "56 >roman print" "lvi" @@ -18,7 +18,7 @@ HELP: >ROMAN { $values { "n" integer } { "str" string } } { $description "Converts a number to its upper-case Roman numeral equivalent." } { $notes "The range for this word is 1-3999, inclusive." } -{ $examples +{ $examples { $example "USING: io roman ;" "56 >ROMAN print" "LVI" @@ -29,7 +29,7 @@ HELP: roman> { $values { "str" string } { "n" integer } } { $description "Converts a Roman numeral to an integer." } { $notes "The range for this word is i-mmmcmxcix, inclusive." } -{ $examples +{ $examples { $example "USING: prettyprint roman ;" "\"lvi\" roman> ." "56" @@ -41,7 +41,7 @@ HELP: roman> HELP: roman+ { $values { "x" string } { "y" string } { "z" string } } { $description "Adds two Roman numerals." } -{ $examples +{ $examples { $example "USING: io roman ;" "\"v\" \"v\" roman+ print" "x" @@ -51,7 +51,7 @@ HELP: roman+ HELP: roman- { $values { "x" string } { "y" string } { "z" string } } { $description "Subtracts two Roman numerals." } -{ $examples +{ $examples { $example "USING: io roman ;" "\"x\" \"v\" roman- print" "v" @@ -63,7 +63,7 @@ HELP: roman- HELP: roman* { $values { "x" string } { "y" string } { "z" string } } { $description "Multiplies two Roman numerals." } -{ $examples +{ $examples { $example "USING: io roman ;" "\"ii\" \"iii\" roman* print" "vi" @@ -73,7 +73,7 @@ HELP: roman* HELP: roman/i { $values { "x" string } { "y" string } { "z" string } } { $description "Computes the integer division of two Roman numerals." } -{ $examples +{ $examples { $example "USING: io roman ;" "\"v\" \"iv\" roman/i print" "i" @@ -83,7 +83,7 @@ HELP: roman/i HELP: roman/mod { $values { "x" string } { "y" string } { "z" string } { "w" string } } { $description "Computes the quotient and remainder of two Roman numerals." } -{ $examples +{ $examples { $example "USING: kernel io roman ;" "\"v\" \"iv\" roman/mod [ print ] bi@" "i\ni" @@ -94,7 +94,7 @@ HELP: roman/mod HELP: ROMAN: { $description "A parsing word that reads the next token and converts it to an integer." } -{ $examples +{ $examples { $example "USING: prettyprint roman ;" "ROMAN: v ." "5" diff --git a/basis/serialize/serialize-docs.factor b/basis/serialize/serialize-docs.factor index 7ba57d819d..61439e3d7c 100644 --- a/basis/serialize/serialize-docs.factor +++ b/basis/serialize/serialize-docs.factor @@ -17,7 +17,7 @@ HELP: object>bytes { $description "Serializes the object to a byte array." } ; HELP: bytes>object -{ $values { "bytes" byte-array } { "obj" "deserialized object" } +{ $values { "bytes" byte-array } { "obj" "deserialized object" } } { $description "Deserializes an object from a byte array." } ; diff --git a/basis/specialized-vectors/specialized-vectors-docs.factor b/basis/specialized-vectors/specialized-vectors-docs.factor index bd68a3b533..b5f24f6f62 100644 --- a/basis/specialized-vectors/specialized-vectors-docs.factor +++ b/basis/specialized-vectors/specialized-vectors-docs.factor @@ -30,7 +30,7 @@ HELP: push-new { $code """foo 5 >>a 6 >>b -foo-vector{ } clone push""" } +foo-vector{ } clone push""" } "By using " { $snippet "push-new" } ", the new struct can be allocated directly from the vector and the intermediate copy can be avoided:" { $code """foo-vector{ } clone push-new 5 >>a diff --git a/basis/tools/continuations/continuations-docs.factor b/basis/tools/continuations/continuations-docs.factor index bd69fb48ca..673b8bdda7 100644 --- a/basis/tools/continuations/continuations-docs.factor +++ b/basis/tools/continuations/continuations-docs.factor @@ -3,4 +3,4 @@ USING: help.markup help.syntax ; HELP: break { $description "A breakpoint. When this word is executed, the walker tool opens with execution suspended at the breakpoint's location." } -{ $see-also "ui-walker" } ; \ No newline at end of file +{ $see-also "ui-walker" } ; diff --git a/basis/tools/coverage/coverage-docs.factor b/basis/tools/coverage/coverage-docs.factor index 90ac1d1bf0..161213e03c 100644 --- a/basis/tools/coverage/coverage-docs.factor +++ b/basis/tools/coverage/coverage-docs.factor @@ -9,11 +9,11 @@ HELP: { "executed?" boolean } { "coverage-state" coverage-state } } -{ $description "Makes a coverage tuple. Users should not call this directly." } ; +{ $description "Makes a coverage tuple. Users should not call this directly." } ; HELP: each-word { $values - { "string" string } { "quot" quotation } + { "string" string } { "quot" quotation } } { $description "Calls a quotation on every word in the vocabulary and its private vocabulary, if there is one." } ; @@ -39,7 +39,7 @@ HELP: coverage-on HELP: coverage. { $values - { "object" object } + { "object" object } } { $description "Calls the coverage word on all the words in a vocabalary or on a single word and prints out a report." } ; @@ -52,7 +52,7 @@ HELP: %coverage HELP: add-coverage { $values - { "object" object } + { "object" object } } { $description "Recompiles a vocabulary with the coverage annotation. Note that the annotation tool is still disabled until you call " { $link coverage-on } "." } ; @@ -64,19 +64,19 @@ HELP: covered HELP: flag-covered { $values - { "coverage" object } + { "coverage" object } } { $description "A word that sets the " { $snippet "executed?" } " slot of the coverage tuple when the covered value is true." } ; HELP: remove-coverage { $values - { "object" object } + { "object" object } } { $description "Recompiles a vocabulary without the coverage annotation." } ; HELP: reset-coverage { $values - { "object" object } + { "object" object } } { $description "Sets the " { $snippet "execute?" } " slot of each coverage tuple to false." } ; diff --git a/basis/tools/coverage/testvocab/testvocab-docs.factor b/basis/tools/coverage/testvocab/testvocab-docs.factor index aaa21a41f9..69ab9338dc 100644 --- a/basis/tools/coverage/testvocab/testvocab-docs.factor +++ b/basis/tools/coverage/testvocab/testvocab-docs.factor @@ -7,4 +7,3 @@ ARTICLE: "tools.coverage.testvocab" "Coverage tool dummy test vocabulary" "The " { $vocab-link "tools.coverage.testvocab" } " vocabulary is just a dummy vocabulary to test " { $vocab-link "tools.coverage" } "." ; ABOUT: "tools.coverage.testvocab" - diff --git a/basis/tools/errors/errors-docs.factor b/basis/tools/errors/errors-docs.factor index 96814169a5..f52a2c5c13 100644 --- a/basis/tools/errors/errors-docs.factor +++ b/basis/tools/errors/errors-docs.factor @@ -47,4 +47,4 @@ $nl { $subsections errors. } "Batch errors are reported in the " { $link "ui.tools.error-list" } "." ; -ABOUT: "tools.errors" \ No newline at end of file +ABOUT: "tools.errors" diff --git a/basis/tuple-arrays/tuple-arrays-docs.factor b/basis/tuple-arrays/tuple-arrays-docs.factor index 72a5ae4df3..8a1bc97686 100644 --- a/basis/tuple-arrays/tuple-arrays-docs.factor +++ b/basis/tuple-arrays/tuple-arrays-docs.factor @@ -26,4 +26,4 @@ $nl "T{ point f 1 2 }" } ; -ABOUT: "tuple-arrays" \ No newline at end of file +ABOUT: "tuple-arrays" diff --git a/basis/ui/commands/commands-docs.factor b/basis/ui/commands/commands-docs.factor index d3ed8156bc..3e5c7f46ae 100644 --- a/basis/ui/commands/commands-docs.factor +++ b/basis/ui/commands/commands-docs.factor @@ -97,7 +97,7 @@ HELP: $command { $description "Prints the keyboard shortcut associated with " { $snippet "command" } " in the command map named " { $snippet "map" } " on the class " { $snippet "class" } "." } ; HELP: define-command -{ $values { "word" word } { "hash" hashtable } } +{ $values { "word" word } { "hash" hashtable } } { $description "Defines a command. The hashtable can contain the following keys:" { $list { { $link +nullary+ } " - if set to a true value, the word must have stack effect " { $snippet "( -- )" } "; otherwise it must have stack effect " { $snippet "( target -- )" } } diff --git a/basis/ui/gadgets/grid-lines/grid-lines-docs.factor b/basis/ui/gadgets/grid-lines/grid-lines-docs.factor index e28786723e..2954169dfa 100644 --- a/basis/ui/gadgets/grid-lines/grid-lines-docs.factor +++ b/basis/ui/gadgets/grid-lines/grid-lines-docs.factor @@ -16,4 +16,4 @@ ARTICLE: "ui.gadgets.grid-lines" "Grid lines" } ; -ABOUT: "ui.gadgets.grid-lines" \ No newline at end of file +ABOUT: "ui.gadgets.grid-lines" diff --git a/basis/ui/gadgets/line-support/line-support-docs.factor b/basis/ui/gadgets/line-support/line-support-docs.factor index f52b2efe1f..9c082896d9 100644 --- a/basis/ui/gadgets/line-support/line-support-docs.factor +++ b/basis/ui/gadgets/line-support/line-support-docs.factor @@ -34,4 +34,4 @@ $nl y>line } ; -ABOUT: "ui.gadgets.line-support" \ No newline at end of file +ABOUT: "ui.gadgets.line-support" diff --git a/basis/ui/gadgets/presentations/presentations-docs.factor b/basis/ui/gadgets/presentations/presentations-docs.factor index 0b33172377..7ffb9e8718 100644 --- a/basis/ui/gadgets/presentations/presentations-docs.factor +++ b/basis/ui/gadgets/presentations/presentations-docs.factor @@ -21,11 +21,11 @@ HELP: invoke-presentation { invoke-presentation invoke-primary invoke-secondary } related-words HELP: invoke-primary -{ $values { "presentation" presentation } } +{ $values { "presentation" presentation } } { $description "Invokes the " { $link primary-operation } " associated to the " { $snippet "object" } ". This word is executed when the presentation is clicked with the left mouse button." } ; HELP: invoke-secondary -{ $values { "presentation" presentation } } +{ $values { "presentation" presentation } } { $description "Invokes the " { $link secondary-operation } " associated to the " { $snippet "object" } ". This word is executed when a list receives a " { $snippet "RET" } " key press." } ; HELP: diff --git a/basis/ui/gadgets/tables/tables-docs.factor b/basis/ui/gadgets/tables/tables-docs.factor index 45f948e14a..ccacc1cff9 100644 --- a/basis/ui/gadgets/tables/tables-docs.factor +++ b/basis/ui/gadgets/tables/tables-docs.factor @@ -72,4 +72,4 @@ $nl "ui.gadgets.tables.example" } ; -ABOUT: "ui.gadgets.tables" \ No newline at end of file +ABOUT: "ui.gadgets.tables" diff --git a/basis/ui/gadgets/worlds/worlds-docs.factor b/basis/ui/gadgets/worlds/worlds-docs.factor index ccb651ad30..4c1fc3b964 100644 --- a/basis/ui/gadgets/worlds/worlds-docs.factor +++ b/basis/ui/gadgets/worlds/worlds-docs.factor @@ -120,4 +120,3 @@ $nl "gl-utilities" "text-rendering" } ; - diff --git a/basis/ui/pens/pens-docs.factor b/basis/ui/pens/pens-docs.factor index 4a5ec277f0..d95bc2d8c5 100644 --- a/basis/ui/pens/pens-docs.factor +++ b/basis/ui/pens/pens-docs.factor @@ -2,11 +2,11 @@ IN: ui.pens USING: help.markup help.syntax kernel ui.gadgets ; HELP: draw-interior -{ $values { "gadget" gadget } { "pen" object } } +{ $values { "gadget" gadget } { "pen" object } } { $contract "Draws the interior of a gadget by making OpenGL calls. The " { $snippet "interior" } " slot may be set to objects implementing this generic word." } ; HELP: draw-boundary -{ $values { "gadget" gadget } { "pen" object } } +{ $values { "gadget" gadget } { "pen" object } } { $contract "Draws the boundary of a gadget by making OpenGL calls. The " { $snippet "boundary" } " slot may be set to objects implementing this generic word." } ; ARTICLE: "ui-pen-protocol" "UI pen protocol" diff --git a/basis/ui/render/render-docs.factor b/basis/ui/render/render-docs.factor index 9348569a5f..4a7b5e8dc2 100644 --- a/basis/ui/render/render-docs.factor +++ b/basis/ui/render/render-docs.factor @@ -26,7 +26,7 @@ HELP: clip { $var-description "The current clipping rectangle." } ; HELP: draw-gadget* -{ $values { "gadget" gadget } } +{ $values { "gadget" gadget } } { $contract "Draws the gadget by making OpenGL calls. The top-left corner of the gadget should be drawn at the location stored in the " { $link origin } " variable." } { $notes "This word should not be called directly. To force a gadget to redraw, call " { $link relayout-1 } "." } ; diff --git a/basis/ui/text/text-docs.factor b/basis/ui/text/text-docs.factor index aef4b91b9a..dec4083a8f 100644 --- a/basis/ui/text/text-docs.factor +++ b/basis/ui/text/text-docs.factor @@ -77,4 +77,4 @@ ARTICLE: "text-rendering" "Rendering text" draw-string } ; -ABOUT: "text-rendering" \ No newline at end of file +ABOUT: "text-rendering" diff --git a/basis/ui/tools/browser/browser-docs.factor b/basis/ui/tools/browser/browser-docs.factor index 1132e1bdce..e66acacced 100644 --- a/basis/ui/tools/browser/browser-docs.factor +++ b/basis/ui/tools/browser/browser-docs.factor @@ -13,4 +13,4 @@ ARTICLE: "ui-browser" "UI browser" { $command-map browser-gadget "multi-touch" } "Browsers are instances of " { $link browser-gadget } "." ; -ABOUT: "ui-browser" \ No newline at end of file +ABOUT: "ui-browser" diff --git a/basis/unix/groups/groups-docs.factor b/basis/unix/groups/groups-docs.factor index c430525e40..6498e42e5a 100644 --- a/basis/unix/groups/groups-docs.factor +++ b/basis/unix/groups/groups-docs.factor @@ -87,7 +87,7 @@ HELP: ?group-id HELP: all-group-names { $values - + { "seq" sequence } } { $description "Returns a sequence of group names as strings." } ; diff --git a/basis/uuid/uuid-docs.factor b/basis/uuid/uuid-docs.factor index ad8ddba5da..f2f54b6ecd 100644 --- a/basis/uuid/uuid-docs.factor +++ b/basis/uuid/uuid-docs.factor @@ -5,28 +5,28 @@ IN: uuid HELP: uuid1 { $values { "string" "a UUID string" } } -{ $description +{ $description "Generates a UUID (version 1) from the host ID, sequence number, " "and current time." } ; HELP: uuid3 { $values { "namespace" string } { "name" string } { "string" "a UUID string" } } -{ $description +{ $description "Generates a UUID (version 3) from the MD5 hash of a namespace " "UUID and a name." } ; HELP: uuid4 { $values { "string" "a UUID string" } } -{ $description - "Generates a UUID (version 4) from random bits." +{ $description + "Generates a UUID (version 4) from random bits." } ; HELP: uuid5 { $values { "namespace" string } { "name" string } { "string" "a UUID string" } } -{ $description - "Generates a UUID (version 5) from the SHA-1 hash of a namespace " +{ $description + "Generates a UUID (version 5) from the SHA-1 hash of a namespace " "UUID and a name." } ; @@ -34,7 +34,7 @@ HELP: uuid5 ARTICLE: "uuid" "UUID (Universally Unique Identifier)" "The " { $vocab-link "uuid" } " vocabulary is used to generate UUIDs. " "The below words can be used to generate version 1, 3, 4, and 5 UUIDs as specified in RFC 4122." -$nl +$nl "If all you want is a unique ID, you should probably call " { $link uuid1 } " or " { $link uuid4 } "." { $subsections uuid1 @@ -45,5 +45,3 @@ $nl ; ABOUT: "uuid" - - diff --git a/basis/validators/validators-docs.factor b/basis/validators/validators-docs.factor index 1b6deef126..80ad568110 100644 --- a/basis/validators/validators-docs.factor +++ b/basis/validators/validators-docs.factor @@ -40,7 +40,7 @@ HELP: v-max-value { $description "Throws an error if " { $snippet "x" } " is larger than " { $snippet "n" } "." } ; HELP: v-min-value -{ $values { "x" integer } { "n" integer } } +{ $values { "x" integer } { "n" integer } } { $description "Throws an error if " { $snippet "x" } " is smaller than " { $snippet "n" } "." } ; HELP: v-mode diff --git a/basis/wrap/strings/strings-docs.factor b/basis/wrap/strings/strings-docs.factor index adce6f0d55..0e1cc6e54d 100644 --- a/basis/wrap/strings/strings-docs.factor +++ b/basis/wrap/strings/strings-docs.factor @@ -24,4 +24,3 @@ HELP: wrap-string HELP: wrap-indented-string { $values { "string" string } { "width" integer } { "indent" "string or integer" } { "newstring" string } } { $description "Given a " { $snippet "string" } ", alters the whitespace in the string so that each line has no more than " { $snippet "width" } " characters, unless there is a word longer than " { $snippet "width" } ". Linear whitespace between words is converted to a single space. The " { $snippet "indent" } " can be either a " { $link string } " or a number of spaces to prepend to each line." } ; - diff --git a/basis/wrap/wrap-docs.factor b/basis/wrap/wrap-docs.factor index feac7c51a7..d5531bfbaf 100644 --- a/basis/wrap/wrap-docs.factor +++ b/basis/wrap/wrap-docs.factor @@ -7,5 +7,5 @@ ABOUT: "wrap" ARTICLE: "wrap" "Word wrapping" "The " { $vocab-link "wrap" } " vocabulary implements word wrapping. Wrapping can take place based on simple strings, assumed to be monospace, or abstract word objects." -{ $vocab-subsection "String word wrapping" "wrap.strings" } +{ $vocab-subsection "String word wrapping" "wrap.strings" } { $vocab-subsection "Word object wrapping" "wrap.words" } ; diff --git a/basis/xml/entities/entities-docs.factor b/basis/xml/entities/entities-docs.factor index 13cc51bbf2..791a0828cb 100644 --- a/basis/xml/entities/entities-docs.factor +++ b/basis/xml/entities/entities-docs.factor @@ -21,4 +21,3 @@ HELP: entities HELP: with-entities { $values { "entities" "a hash table of strings to strings" } { "quot" "a quotation ( -- )" } } { $description "Calls the quotation using the given table of entity values (symbolizing, eg, that " { $snippet "&foo;" } " represents " { $snippet "\"a\"" } ") on top of the default XML entities" } ; - diff --git a/basis/xml/syntax/syntax-docs.factor b/basis/xml/syntax/syntax-docs.factor index d1e3781dc8..7af84833ef 100644 --- a/basis/xml/syntax/syntax-docs.factor +++ b/basis/xml/syntax/syntax-docs.factor @@ -53,7 +53,7 @@ ARTICLE: { "xml.syntax" "interpolation" } "XML interpolation syntax" "XML interpolation has two forms for each of the words " { $link POSTPONE: " } ". To splice something in from the stack, in the style of " { $vocab-link "fry" } ", use the syntax " { $snippet "<->" } ". An XML interpolation form may only use one of these styles." $nl "These forms can be used where a tag might go, as in " { $snippet "[XML <-> XML]" } " or where an attribute might go, as in " { $snippet "[XML /> XML]" } ". When an attribute is spliced in, it is not included if the value is " { $snippet "f" } " and if the value is not a string, the value is put through " { $link present } ". Here is an example of the fry style of XML interpolation:" -{ $example +{ $example """USING: splitting xml.writer xml.syntax ; "one two three" " " split [ [XML <-> XML] ] map diff --git a/core/byte-vectors/byte-vectors-docs.factor b/core/byte-vectors/byte-vectors-docs.factor index 436120c2ca..72e3741e72 100644 --- a/core/byte-vectors/byte-vectors-docs.factor +++ b/core/byte-vectors/byte-vectors-docs.factor @@ -36,5 +36,5 @@ HELP: >byte-vector HELP: BV{ { $syntax "BV{ elements... }" } { $values { "elements" "a list of bytes" } } -{ $description "Marks the beginning of a literal byte vector. Literal byte vectors are terminated by " { $link POSTPONE: } } "." } +{ $description "Marks the beginning of a literal byte vector. Literal byte vectors are terminated by " { $link POSTPONE: } } "." } { $examples { $code "BV{ 1 2 3 12 }" } } ; diff --git a/core/checksums/checksums-docs.factor b/core/checksums/checksums-docs.factor index b08bd9ec70..63657530bd 100644 --- a/core/checksums/checksums-docs.factor +++ b/core/checksums/checksums-docs.factor @@ -76,7 +76,7 @@ $nl { $vocab-subsection "MD5 checksum" "checksums.md5" } { $vocab-subsection "SHA checksums" "checksums.sha" } { $vocab-subsection "Adler-32 checksum" "checksums.adler-32" } -{ $vocab-subsection "OpenSSL checksums" "checksums.openssl" } +{ $vocab-subsection "OpenSSL checksums" "checksums.openssl" } { $vocab-subsection "Internet checksum" "checksums.internet" } ; ABOUT: "checksums" diff --git a/core/classes/builtin/builtin-docs.factor b/core/classes/builtin/builtin-docs.factor index ecc484df11..6b2c56dfb2 100644 --- a/core/classes/builtin/builtin-docs.factor +++ b/core/classes/builtin/builtin-docs.factor @@ -27,4 +27,3 @@ HELP: type>class { $values { "n" "a non-negative integer" } { "class" class } } { $description "Outputs a builtin class whose instances are precisely those having a given pointer tag." } { $notes "The parameter " { $snippet "n" } " must be between 0 and the return value of " { $link num-types } "." } ; - diff --git a/core/effects/parser/parser-docs.factor b/core/effects/parser/parser-docs.factor index e345b9d8f0..8fb8e1076c 100644 --- a/core/effects/parser/parser-docs.factor +++ b/core/effects/parser/parser-docs.factor @@ -6,4 +6,3 @@ HELP: parse-effect { $description "Parses a stack effect from the current input line." } { $examples "This word is used by " { $link POSTPONE: ( } " to parse stack effect declarations." } $parsing-note ; - diff --git a/core/generic/hook/hook-docs.factor b/core/generic/hook/hook-docs.factor index 9b57d941c0..88f57a8cc8 100644 --- a/core/generic/hook/hook-docs.factor +++ b/core/generic/hook/hook-docs.factor @@ -7,4 +7,4 @@ HELP: hook-combination "Performs hook method combination . See " { $link POSTPONE: HOOK: } "." } ; -{ standard-combination hook-combination } related-words \ No newline at end of file +{ standard-combination hook-combination } related-words diff --git a/core/io/streams/c/c-docs.factor b/core/io/streams/c/c-docs.factor index bd87d80295..1cb286dc87 100644 --- a/core/io/streams/c/c-docs.factor +++ b/core/io/streams/c/c-docs.factor @@ -59,7 +59,7 @@ HELP: fclose HELP: fgetc { $values { "alien" "a C FILE* handle" } { "byte/f" { $maybe "an integer from 0 to 255" } } } -{ $description "Reads a single byte from a C FILE* handle, and outputs " { $link f } " on end of file." } +{ $description "Reads a single byte from a C FILE* handle, and outputs " { $link f } " on end of file." } { $errors "Throws an error if the input operation failed." } ; HELP: fputc diff --git a/core/math/math-docs.factor b/core/math/math-docs.factor index 2c434cff83..85f21badb4 100644 --- a/core/math/math-docs.factor +++ b/core/math/math-docs.factor @@ -509,4 +509,3 @@ $nl { $see-also "integers" "rationals" "floats" "complex-numbers" } ; ABOUT: "arithmetic" - diff --git a/core/namespaces/namespaces-docs.factor b/core/namespaces/namespaces-docs.factor index 0b2928f5b1..6e38bac6c3 100644 --- a/core/namespaces/namespaces-docs.factor +++ b/core/namespaces/namespaces-docs.factor @@ -95,13 +95,13 @@ HELP: change-global HELP: toggle { $values - { "variable" "a variable, by convention a symbol" } + { "variable" "a variable, by convention a symbol" } } { $description "Changes the boolean value of a variable to its opposite." } ; HELP: with-global { $values - { "quot" quotation } + { "quot" quotation } } { $description "Runs the quotation in the global namespace." } ; diff --git a/core/parser/notes/notes-docs.factor b/core/parser/notes/notes-docs.factor index 3f990ae524..f2ae6ab473 100644 --- a/core/parser/notes/notes-docs.factor +++ b/core/parser/notes/notes-docs.factor @@ -3,4 +3,3 @@ IN: parser.notes HELP: parser-quiet? { $var-description "A boolean controlling whether the parser will print various notes. Switched on by default. If a source file is being run for its effect on " { $link output-stream } ", this variable should remain switched on, to prevent parser notes from polluting the output." } ; - diff --git a/extra/alien/fortran/fortran-docs.factor b/extra/alien/fortran/fortran-docs.factor index 87b3e9e735..d4348100bd 100644 --- a/extra/alien/fortran/fortran-docs.factor +++ b/extra/alien/fortran/fortran-docs.factor @@ -43,7 +43,7 @@ HELP: LIBRARY: { $description "Sets the logical library for subsequent " { $link POSTPONE: FUNCTION: } " and " { $link POSTPONE: SUBROUTINE: } " definitions. The given library name must have been opened with a previous call to " { $link add-fortran-library } "." } ; HELP: add-fortran-library -{ $values { "name" string } { "soname" string } { "fortran-abi" symbol } } +{ $values { "name" string } { "soname" string } { "fortran-abi" symbol } } { $description "Opens the shared library in the file specified by " { $snippet "soname" } " under the logical name " { $snippet "name" } " so that it may be used in subsequent " { $link POSTPONE: LIBRARY: } " and " { $link fortran-invoke } " calls. Functions and subroutines from the library will be defined using the specified " { $snippet "fortran-abi" } ", which must be one of the supported " { $link "alien.fortran-abis" } "." } ; diff --git a/extra/audio/audio-docs.factor b/extra/audio/audio-docs.factor index c08887e962..cb36db6dc0 100644 --- a/extra/audio/audio-docs.factor +++ b/extra/audio/audio-docs.factor @@ -37,7 +37,7 @@ ARTICLE: "audio" "Audio framework" { $list { { $vocab-link "audio.engine" } " provides a high-level OpenAL-based engine for playing audio clips." } { { $vocab-link "audio.loader" } " reads PCM data from files on disk into " { $link audio } " objects. " { $vocab-link "audio.wav" } " and " { $vocab-link "audio.aiff" } " support specific audio file formats." } -{ { $vocab-link "audio.vorbis" } " implements an " { $snippet "audio.engine" } " compatible generator object for decoding Ogg Vorbis audio data from a stream." } +{ { $vocab-link "audio.vorbis" } " implements an " { $snippet "audio.engine" } " compatible generator object for decoding Ogg Vorbis audio data from a stream." } } ; ABOUT: "audio" diff --git a/extra/audio/engine/engine-docs.factor b/extra/audio/engine/engine-docs.factor index a01a4cdf6a..20b195a0cb 100644 --- a/extra/audio/engine/engine-docs.factor +++ b/extra/audio/engine/engine-docs.factor @@ -19,7 +19,7 @@ HELP: HELP: { $values - + { "engine" audio-engine } } { $description "Constructs an " { $link audio-engine } " instance by calling " { $link } " with the default values of " { $link f } " for the " { $snippet "device-name" } " and 16 for the " { $snippet "voice-count" } ". The engine is returned in the stopped state; to start audio processing, use " { $link start-audio } " or " { $link start-audio* } "." } ; @@ -80,7 +80,7 @@ HELP: audio-gain HELP: audio-listener { $class-description "A tuple class that trivially implements the " { $link "audio.engine-listener" } " with accessors on its tuple slots." { $list - { { $snippet "position" } " provides the " { $link audio-position } "." } + { { $snippet "position" } " provides the " { $link audio-position } "." } { { $snippet "gain" } " provides the " { $link audio-gain } "." } { { $snippet "velocity" } " provides the " { $link audio-velocity } "." } { { $snippet "orientation" } " provides the " { $link audio-orientation } "." } @@ -91,7 +91,7 @@ HELP: audio-orientation { "listener" "an object implementing the " { $link "audio.engine-listener" } } { "orientation" audio-orientation } } -{ $description "Returns the orientation of the listener. The orientation must be returned in an " { $snippet "audio-orientation" } " tuple with the following slots:" +{ $description "Returns the orientation of the listener. The orientation must be returned in an " { $snippet "audio-orientation" } " tuple with the following slots:" { $list { { $snippet "forward" } " is a 3-component vector indicating the direction the listener is facing." } { { $snippet "up" } " is a 3-component vector indicating the \"up\" direction for the listener. This vector does not need to be normal to the " { $snippet "forward" } " vector." } @@ -121,7 +121,7 @@ HELP: audio-rolloff HELP: audio-source { $class-description "A tuple class that trivially implements the " { $link "audio.engine-sources" } " with accessors on its tuple slots." { $list - { { $snippet "position" } " provides the " { $link audio-position } "." } + { { $snippet "position" } " provides the " { $link audio-position } "." } { { $snippet "gain" } " provides the " { $link audio-gain } "." } { { $snippet "velocity" } " provides the " { $link audio-velocity } "." } { { $snippet "relative?" } " provides the " { $link audio-relative? } " value." } diff --git a/extra/balloon-bomber/balloon-bomber-docs.factor b/extra/balloon-bomber/balloon-bomber-docs.factor index 7c956b0ed2..00c677b04e 100644 --- a/extra/balloon-bomber/balloon-bomber-docs.factor +++ b/extra/balloon-bomber/balloon-bomber-docs.factor @@ -4,10 +4,10 @@ USING: help.syntax help.markup cpu.8080.emulator ; IN: balloon-bomber HELP: run-balloon -{ $description +{ $description "Run the Balloon Bomber emulator in a new window." $nl { $link rom-root } " must be set to the directory containing the " -"location of the Balloon Bomber ROM files. See " +"location of the Balloon Bomber ROM files. See " { $link { "balloon-bomber" "balloon-bomber" } } " for details." } ; @@ -24,9 +24,9 @@ ARTICLE: { "balloon-bomber" "balloon-bomber" } "Balloon Bomber Emulator" "ballbomb/tn04" "ballbomb/tn05-1" } -"These are the same ROM files as used by MAME. To run the game use the " +"These are the same ROM files as used by MAME. To run the game use the " { $link run-balloon } " word." $nl -"Keys:" +"Keys:" { $table { "Backspace" "Insert Coin" } { "1" "1 Player" } diff --git a/extra/bitcoin/client/client-docs.factor b/extra/bitcoin/client/client-docs.factor index 1df485a73d..5ebd601548 100644 --- a/extra/bitcoin/client/client-docs.factor +++ b/extra/bitcoin/client/client-docs.factor @@ -4,10 +4,10 @@ USING: assocs help.markup help.syntax kernel math sequences strings ; IN: bitcoin.client HELP: bitcoin-server -{ $values - { "string" string } +{ $values + { "string" string } } -{ $description +{ $description "Returns the hostname of the json-rpc server for the bitcoin client. " "This defaults to 'localhost' or the value of the 'bitcoin-server' " "variable." @@ -15,10 +15,10 @@ HELP: bitcoin-server { $see-also bitcoin-port bitcoin-user bitcoin-password } ; HELP: bitcoin-port -{ $values - { "n" number } +{ $values + { "n" number } } -{ $description +{ $description "Returns the port of the json-rpc server for the bitcoin client. " "This defaults to '8332' or the value of the 'bitcoin-port' " "variable." @@ -26,10 +26,10 @@ HELP: bitcoin-port { $see-also bitcoin-server bitcoin-user bitcoin-password } ; HELP: bitcoin-user -{ $values - { "string" string } +{ $values + { "string" string } } -{ $description +{ $description "Returns the username required to authenticate with the json-rpc " "server for the bitcoin client. This defaults to empty or the " "value of the 'bitcoin-user' variable." @@ -37,10 +37,10 @@ HELP: bitcoin-user { $see-also bitcoin-port bitcoin-server bitcoin-password } ; HELP: bitcoin-password -{ $values - { "string" string } +{ $values + { "string" string } } -{ $description +{ $description "Returns the password required to authenticate with the json-rpc " "server for the bitcoin client. This returns the " "value of the 'bitcoin-password' variable." @@ -48,70 +48,70 @@ HELP: bitcoin-password { $see-also bitcoin-port bitcoin-server bitcoin-user } ; HELP: get-addresses-by-label -{ $values - { "label" string } - { "seq" sequence } +{ $values + { "label" string } + { "seq" sequence } } -{ $description +{ $description "Returns the list of addresses with the given label." } ; HELP: get-balance -{ $values - { "n" number } +{ $values + { "n" number } } -{ $description +{ $description "Returns the server's available balance." } ; HELP: get-block-count -{ $values - { "n" number } +{ $values + { "n" number } } -{ $description +{ $description "Returns the number of blocks in the longest block chain." } ; HELP: get-block-number -{ $values - { "n" number } +{ $values + { "n" number } } -{ $description +{ $description "Returns the block number of the latest block in the longest block chain." } ; HELP: get-connection-count -{ $values - { "n" number } +{ $values + { "n" number } } -{ $description +{ $description "Returns the number of connections to other nodes." } ; HELP: get-difficulty -{ $values - { "n" number } +{ $values + { "n" number } } -{ $description +{ $description "Returns the proof-of-work difficulty as a multiple of the minimum " "difficulty." } ; HELP: get-generate -{ $values - { "?" boolean } +{ $values + { "?" boolean } } -{ $description +{ $description "Returns true if the server is trying to generate bitcoins, false " "otherwise." } ; HELP: set-generate -{ $values - { "gen" boolean } - { "n" number } +{ $values + { "gen" boolean } + { "n" number } } -{ $description +{ $description "If 'gen' is true, the server starts generating bitcoins. If 'gen' is " "'false' then the server stops generating bitcoins. 'n' is the number " "of CPU's to use while generating. A value of '-1' means use all the " @@ -119,106 +119,106 @@ HELP: set-generate } ; HELP: get-info -{ $values +{ $values { "result" assoc } } -{ $description +{ $description "Returns an assoc containing server information." } ; HELP: get-label -{ $values - { "address" string } - { "label" string } +{ $values + { "address" string } + { "label" string } } -{ $description +{ $description "Returns the label associated with the given address." } ; HELP: set-label -{ $values - { "address" string } - { "label" string } +{ $values + { "address" string } + { "label" string } } -{ $description +{ $description "Sets the label associateed with the given address." } ; HELP: remove-label -{ $values - { "address" string } +{ $values + { "address" string } } -{ $description +{ $description "Removes the label associated with the given address." } ; HELP: get-new-address -{ $values - { "address" string } +{ $values + { "address" string } } -{ $description +{ $description "Returns a new bitcoin address for receiving payments." } ; HELP: get-new-labelled-address -{ $values - { "label" string } - { "address" string } +{ $values + { "label" string } + { "address" string } } -{ $description +{ $description "Returns a new bitcoin address for receiving payments. The given " "label is associated with the new address." } ; HELP: get-received-by-address -{ $values - { "address" string } +{ $values + { "address" string } { "amount" number } } -{ $description +{ $description "Returns the total amount received by the address in transactions " "with at least one confirmation." } ; HELP: get-confirmed-received-by-address -{ $values - { "address" string } +{ $values + { "address" string } { "minconf" number } { "amount" number } } -{ $description +{ $description "Returns the total amount received by the address in transactions " "with at least 'minconf' confirmations." } ; HELP: get-received-by-label -{ $values - { "label" string } +{ $values + { "label" string } { "amount" number } } -{ $description +{ $description "Returns the total amount received by addresses with 'label' in transactions " "with at least one confirmation." } ; HELP: get-confirmed-received-by-label -{ $values - { "label" string } +{ $values + { "label" string } { "minconf" number } { "amount" number } } -{ $description +{ $description "Returns the total amount received by the addresses with 'label' in transactions " "with at least 'minconf' confirmations." } ; HELP: list-received-by-address -{ $values - { "minconf" number } +{ $values + { "minconf" number } { "include-empty" boolean } { "seq" sequence } } -{ $description +{ $description "Return a sequence containing an assoc of data about the payments an " "address has received. 'include-empty' indicates whether addresses that " "haven't received any payments should be included. 'minconf' is the " @@ -226,12 +226,12 @@ HELP: list-received-by-address } ; HELP: list-received-by-label -{ $values - { "minconf" number } +{ $values + { "minconf" number } { "include-empty" boolean } { "seq" sequence } } -{ $description +{ $description "Return a sequence containing an assoc of data about the payments that " "addresses with the given label have received. 'include-empty' " " indicates whether addresses that " @@ -240,32 +240,30 @@ HELP: list-received-by-label } ; HELP: send-to-address -{ $values - { "address" string } +{ $values + { "address" string } { "amount" number } { "?" boolean } } -{ $description +{ $description "Sends 'amount' from the server's available balance to 'address'. " "'amount' is rounded to the nearest 0.01. Returns a boolean indicating " "if the call succeeded." } ; HELP: stop -{ $description +{ $description "Stops the bitcoin server." } ; HELP: list-transactions -{ $values - { "count" number } +{ $values + { "count" number } { "include-generated" boolean } { "seq" sequence } } -{ $description +{ $description "Return's a sequence containing up to 'count' most recent transactions." "This requires a patched bitcoin server so may not work with old or unpatched " "servers." } ; - - diff --git a/extra/brainfuck/brainfuck-docs.factor b/extra/brainfuck/brainfuck-docs.factor index c11c05a2e2..e7cec42589 100644 --- a/extra/brainfuck/brainfuck-docs.factor +++ b/extra/brainfuck/brainfuck-docs.factor @@ -3,7 +3,7 @@ USING: help.syntax help.markup brainfuck strings ; -IN: brainfuck +IN: brainfuck HELP: run-brainfuck { $values { "code" string } } @@ -45,5 +45,5 @@ HELP: run-brainfuck HELP: get-brainfuck { $values { "code" string } { "result" string } } -{ $description "Returns the output from a brainfuck program as a result string." } +{ $description "Returns the output from a brainfuck program as a result string." } { $see-also run-brainfuck } ; diff --git a/extra/combinators/extras/extras-docs.factor b/extra/combinators/extras/extras-docs.factor index f40e4f7e69..ed8af7ad35 100644 --- a/extra/combinators/extras/extras-docs.factor +++ b/extra/combinators/extras/extras-docs.factor @@ -20,5 +20,3 @@ HELP: cond-case "zero" } } ; - - diff --git a/extra/cpu/8080/8080-docs.factor b/extra/cpu/8080/8080-docs.factor index d1f90b6400..33a1f2d5e8 100644 --- a/extra/cpu/8080/8080-docs.factor +++ b/extra/cpu/8080/8080-docs.factor @@ -7,10 +7,10 @@ IN: cpu.8080 ARTICLE: { "cpu-8080" "cpu-8080" } "Intel 8080 CPU Emulator" "The cpu-8080 library provides an emulator for the Intel 8080 CPU" " instruction set. It is complete enough to emulate some 8080" -" based arcade games." $nl +" based arcade games." $nl "The emulated CPU can load 'ROM' files from disk using the " { $link load-rom } " and " { $link load-rom* } " words. These expect " "the " { $link rom-root } " variable to be set to the path " "containing the ROM file's." ; -ABOUT: { "cpu-8080" "cpu-8080" } +ABOUT: { "cpu-8080" "cpu-8080" } diff --git a/extra/cpu/8080/emulator/emulator-docs.factor b/extra/cpu/8080/emulator/emulator-docs.factor index da2e1f318b..014df251f1 100644 --- a/extra/cpu/8080/emulator/emulator-docs.factor +++ b/extra/cpu/8080/emulator/emulator-docs.factor @@ -3,10 +3,10 @@ USING: help.markup help.syntax sequences strings ; IN: cpu.8080.emulator -HELP: load-rom +HELP: load-rom { $values { "filename" string } { "cpu" cpu } } -{ $description -"Read the ROM file into the cpu's memory starting at address 0000. " +{ $description +"Read the ROM file into the cpu's memory starting at address 0000. " "The filename is relative to the path stored in the " { $link rom-root } " variable. An exception is thrown if this variable is not set." } @@ -14,7 +14,7 @@ HELP: load-rom HELP: load-rom* { $values { "seq" sequence } { "cpu" cpu } } -{ $description +{ $description "Loads one or more ROM files into the cpu's memory. Each file is " "loaded at a particular starting address. 'seq' is a sequence of " "2 element arrays. The first element is the address and the second " @@ -28,7 +28,7 @@ HELP: load-rom* { $see-also load-rom } ; HELP: rom-root -{ $description +{ $description "Holds the path where the ROM files are stored. Used for expanding " "the relative filenames passed to " { $link load-rom } " and " { $link load-rom* } "." diff --git a/extra/fonts/syntax/syntax-docs.factor b/extra/fonts/syntax/syntax-docs.factor index 7edd6d7e47..768f0b7b85 100644 --- a/extra/fonts/syntax/syntax-docs.factor +++ b/extra/fonts/syntax/syntax-docs.factor @@ -3,4 +3,4 @@ IN: fonts.syntax HELP: FONT: { $syntax "\"testing\"