docs: Fix help-lint-all mistakes.

elevate-erg
Doug Coleman 2018-07-07 00:44:46 -05:00
parent ff466b894a
commit 4e9d383fe5
33 changed files with 88 additions and 55 deletions

View File

@ -1,7 +1,7 @@
! Copyright (C) 2009 Slava Pestov. ! Copyright (C) 2009 Slava Pestov.
! See http://factorcode.org/license.txt for BSD license. ! See http://factorcode.org/license.txt for BSD license.
USING: alien alien.syntax assocs help.markup help.syntax strings words USING: alien alien.syntax assocs help.markup help.syntax kernel
; strings ;
IN: alien.libraries IN: alien.libraries
HELP: add-library HELP: add-library
@ -73,7 +73,7 @@ HELP: library
} ; } ;
HELP: library-dll HELP: library-dll
{ $values { "name" string } { "dll" "a DLL handle" } } { $values { "obj" object } { "dll" "a DLL handle" } }
{ $description "Looks up a library by logical name and outputs a handle which may be passed to " { $link dlsym } " or " { $link dlclose } "." } ; { $description "Looks up a library by logical name and outputs a handle which may be passed to " { $link dlsym } " or " { $link dlclose } "." } ;
HELP: remove-library HELP: remove-library

View File

@ -19,7 +19,7 @@ HELP: primitive-quot
{ $description "Creates the defining quotation for the primitive. If 'vm-func' is a string, then it is prefixed with 'primitive_' and a quotation calling that C++ function is generated." } ; { $description "Creates the defining quotation for the primitive. If 'vm-func' is a string, then it is prefixed with 'primitive_' and a quotation calling that C++ function is generated." } ;
ARTICLE: "bootstrap.image.primitives" "Bootstrap primitives" ARTICLE: "bootstrap.image.primitives" "Bootstrap primitives"
"This vocab contains utilities for declaring primitives to be added to the bootstrap image. It is used by " { $vocab-link "bootstrap.primitives" } "This vocab contains utilities for declaring primitives to be added to the bootstrap image. It is used by the file " { $snippet "resource:core/bootstrap/primitives.factor" }
$nl $nl
{ $link all-primitives } " is an assoc where all primitives are declared. See that constant for a description of the format." ; { $link all-primitives } " is an assoc where all primitives are declared. See that constant for a description of the format." ;

View File

@ -1,7 +1,7 @@
USING: assocs compiler.cfg compiler.cfg.builder.blocks USING: arrays assocs compiler.cfg compiler.cfg.builder.blocks
compiler.cfg.instructions compiler.cfg.stacks.local compiler.tree compiler.cfg.instructions compiler.cfg.stacks.local
help.markup help.syntax kernel literals math multiline quotations compiler.tree help.markup help.syntax kernel literals math
sequences vectors words ; multiline quotations sequences vectors words ;
IN: compiler.cfg.builder IN: compiler.cfg.builder
<< <<
@ -104,7 +104,7 @@ HELP: end-word
{ $description "Ends the word by adding a basic block containing a " { $link ##return } " instructions to the " { $link cfg } "." } ; { $description "Ends the word by adding a basic block containing a " { $link ##return } " instructions to the " { $link cfg } "." } ;
HELP: height-changes HELP: height-changes
{ $values { "#shuffle" #shuffle } { "height-changes" sequence } } { $values { "#shuffle" #shuffle } { "height-changes" pair } }
{ $description "Returns a two-tuple which represents how much the " { $link #shuffle } " node increases or decreases the data and retainstacks." } { $description "Returns a two-tuple which represents how much the " { $link #shuffle } " node increases or decreases the data and retainstacks." }
{ $examples { $examples
{ $example { $example
@ -115,7 +115,7 @@ HELP: height-changes
} ; } ;
HELP: out-vregs/stack HELP: out-vregs/stack
{ $values { "#shuffle" #shuffle } { "seq" sequence } } { $values { "#shuffle" #shuffle } { "pair" sequence } }
{ $description "Returns a sequence of what vregs are on which stack locations after the shuffle instruction." } ; { $description "Returns a sequence of what vregs are on which stack locations after the shuffle instruction." } ;
HELP: trivial-branch? HELP: trivial-branch?

View File

@ -72,7 +72,7 @@ HELP: vreg>reg
{ $see-also lookup-spill-slot pending-interval-assoc } ; { $see-also lookup-spill-slot pending-interval-assoc } ;
HELP: vregs>regs HELP: vregs>regs
{ $values { "assoc" "an " { $link assoc } " (set) of virtual registers" } { "assoc" assoc } } { $values { "assoc" "an " { $link assoc } " (set) of virtual registers" } { "assoc'" assoc } }
{ $description "Creates a mapping of virtual registers to registers." } ; { $description "Creates a mapping of virtual registers to registers." } ;
HELP: vreg>spill-slot HELP: vreg>spill-slot

View File

@ -29,7 +29,7 @@ SYMBOL: pending-interval-assoc
: remove-pending ( live-interval -- ) : remove-pending ( live-interval -- )
vreg>> pending-interval-assoc get delete-at ; vreg>> pending-interval-assoc get delete-at ;
: vreg>spill-slot ( vreg -- slot ) : vreg>spill-slot ( vreg -- spill-slot )
dup rep-of lookup-spill-slot ; dup rep-of lookup-spill-slot ;
: vreg>reg ( vreg -- reg/spill-slot ) : vreg>reg ( vreg -- reg/spill-slot )

View File

@ -51,7 +51,7 @@ HELP: height-state
{ $see-also inc-stack reset-incs } ; { $see-also inc-stack reset-incs } ;
HELP: height-state>insns HELP: height-state>insns
{ $values { "state" sequence } { "insns" sequence } } { $values { "height-state" height-state } { "insns" sequence } }
{ $description "Converts a " { $link height-state } " tuple to 0-2 stack height change instructions." } { $description "Converts a " { $link height-state } " tuple to 0-2 stack height change instructions." }
{ $examples { $examples
"In this example the datastacks height is increased by 4 and the retainstacks decreased by 2." "In this example the datastacks height is increased by 4 and the retainstacks decreased by 2."
@ -67,7 +67,7 @@ HELP: inc-stack
{ $description "Increases or decreases the data or retain stack depending on if loc is a " { $link ds-loc } " or " { $link rs-loc } " instance. An " { $link ##inc } " instruction will later be inserted." } ; { $description "Increases or decreases the data or retain stack depending on if loc is a " { $link ds-loc } " or " { $link rs-loc } " instance. An " { $link ##inc } " instruction will later be inserted." } ;
HELP: local-loc>global HELP: local-loc>global
{ $values { "loc" loc } { "bb" basic-block } { "loc'" loc } } { $values { "loc" loc } { "height-state" height-state } { "loc'" loc } }
{ $description "Translates a stack location relative to a block to an absolute one. The word does the opposite to " { $link global-loc>local } "." } ; { $description "Translates a stack location relative to a block to an absolute one. The word does the opposite to " { $link global-loc>local } "." } ;
HELP: loc>vreg HELP: loc>vreg
@ -76,10 +76,11 @@ HELP: loc>vreg
HELP: local-kill-set HELP: local-kill-set
{ $values { $values
{ "ds-height" integer } { "ds-begin" integer }
{ "ds-inc" integer } { "ds-inc" integer }
{ "rs-height" integer } { "rs-begin" integer }
{ "rs-inc" integer } { "rs-inc" integer }
{ "set" hash-set }
} }
{ $description "The set of stack locations that was killed. Locations on a stack are deemed killed if that stacks height is decremented." } { $description "The set of stack locations that was killed. Locations on a stack are deemed killed if that stacks height is decremented." }
{ $see-also compute-local-kill-set } ; { $see-also compute-local-kill-set } ;

View File

@ -75,6 +75,7 @@ init-relocation [ RAX RBX 3 -14 RCX RDX %write-barrier ] B{ } make disassemble
HELP: %alien-invoke HELP: %alien-invoke
{ $values { $values
{ "varargs?" boolean }
{ "reg-inputs" sequence } { "reg-inputs" sequence }
{ "stack-inputs" sequence } { "stack-inputs" sequence }
{ "reg-outputs" sequence } { "reg-outputs" sequence }
@ -292,12 +293,18 @@ HELP: %store-memory-imm
HELP: %test-imm-branch HELP: %test-imm-branch
{ $values { $values
{ "label" "branch destination" } { "label" "branch destination" }
{ "cc" "comparison symbol" }
{ "src1" "register" } { "src1" "register" }
{ "src2" "immediate" } { "src2" "immediate" }
{ "cc" "comparison symbol" }
} { $description "Emits a TEST instruction with a register and an immediate, followed by a branch." } ; } { $description "Emits a TEST instruction with a register and an immediate, followed by a branch." } ;
HELP: %unbox HELP: %unbox
{ $values
{ "dst" "destination register" }
{ "src" "source register" }
{ "func" "function?" }
{ "rep" representation }
}
{ $description "Call a function to convert a tagged pointer into a value that can be passed to a C function, or returned from a callback." } ; { $description "Call a function to convert a tagged pointer into a value that can be passed to a C function, or returned from a callback." } ;
HELP: %vector>scalar HELP: %vector>scalar

View File

@ -522,7 +522,7 @@ HOOK: fused-unboxing? cpu ( -- ? )
HOOK: immediate-arithmetic? cpu ( n -- ? ) HOOK: immediate-arithmetic? cpu ( n -- ? )
HOOK: immediate-bitwise? cpu ( n -- ? ) HOOK: immediate-bitwise? cpu ( n -- ? )
HOOK: immediate-comparand? cpu ( n -- ? ) HOOK: immediate-comparand? cpu ( n -- ? )
HOOK: immediate-store? cpu ( obj -- ? ) HOOK: immediate-store? cpu ( n -- ? )
M: object immediate-comparand? ( n -- ? ) M: object immediate-comparand? ( n -- ? )
{ {

View File

@ -110,7 +110,7 @@ HELP: count-of-things
} ; } ;
HELP: ?pluralize HELP: ?pluralize
{ $values { "count" number } { "singular" string } { "singluar/plural" string } } { $values { "count" number } { "singular" string } { "singular/plural" string } }
{ $description "A simpler variant of " { $link count-of-things } " which omits its input value from the output. As with " { $link count-of-things } ", " { $snippet "word" } " is expected to be in singular form." } { $description "A simpler variant of " { $link count-of-things } " which omits its input value from the output. As with " { $link count-of-things } ", " { $snippet "word" } " is expected to be in singular form." }
{ $notes { $list $keep-case $0-plurality } } { $notes { $list $keep-case $0-plurality } }
{ $examples { $examples
@ -189,7 +189,7 @@ HELP: comma-list
} ; } ;
HELP: or-markup-example HELP: or-markup-example
{ $values { "markup" "a sequence of markup elements" } { "classes" "a sequence of words" } } { $values { "classes" "a sequence of words" } { "markup" "a sequence of markup elements" } }
{ $description "Used to implement " { $link $or-markup-example } " and demonstrate " { $link comma-list } "." } { $description "Used to implement " { $link $or-markup-example } " and demonstrate " { $link comma-list } "." }
{ $examples { "See the examples in " { $link $or-markup-example } "." } } ; { $examples { "See the examples in " { $link $or-markup-example } "." } } ;

View File

@ -42,7 +42,7 @@ GENERIC: valid-article? ( topic -- ? )
GENERIC: article-title ( topic -- string ) GENERIC: article-title ( topic -- string )
GENERIC: article-name ( topic -- string ) GENERIC: article-name ( topic -- string )
GENERIC: article-content ( topic -- content ) GENERIC: article-content ( topic -- content )
GENERIC: article-parent ( topic -- parent ) GENERIC: article-parent ( topic -- parent/f )
GENERIC: set-article-parent ( parent topic -- ) GENERIC: set-article-parent ( parent topic -- )
M: object article-name article-title ; M: object article-name article-title ;

View File

@ -20,7 +20,7 @@ $nl
"This variable should never be set directly; instead, use " { $link set-current-directory } " or " { $link with-directory } ". This preserves the invariant that the value of this variable is an absolute path." } ; "This variable should never be set directly; instead, use " { $link set-current-directory } " or " { $link with-directory } ". This preserves the invariant that the value of this variable is an absolute path." } ;
HELP: make-parent-directories HELP: make-parent-directories
{ $values { "path" "a pathname string" } } { $values { "filename" "a pathname string" } }
{ $description "Creates all parent directories of the path which do not yet exist." } { $description "Creates all parent directories of the path which do not yet exist." }
{ $errors "Throws an error if the directories could not be created." } ; { $errors "Throws an error if the directories could not be created." } ;

View File

@ -109,11 +109,11 @@ HELP: lappend-lazy
{ $description "Perform a similar functionality to that of the " { $link append } " word, but in a lazy manner. No evaluation of the list elements occurs initially but a " { $link lazy-append } " object is returned which conforms to the list protocol. Calling " { $link car } ", " { $link cdr } " or " { $link nil? } " on this will evaluate elements as required. Successive calls to " { $link cdr } " will iterate through list1, followed by list2." } ; { $description "Perform a similar functionality to that of the " { $link append } " word, but in a lazy manner. No evaluation of the list elements occurs initially but a " { $link lazy-append } " object is returned which conforms to the list protocol. Calling " { $link car } ", " { $link cdr } " or " { $link nil? } " on this will evaluate elements as required. Successive calls to " { $link cdr } " will iterate through list1, followed by list2." } ;
HELP: lfrom-by HELP: lfrom-by
{ $values { "n" integer } { "quot" { $quotation ( n -- o ) } } { "lazy-from-by" "a lazy list of integers" } } { $values { "n" integer } { "quot" { $quotation ( n -- o ) } } { "result" "a lazy list of integers" } }
{ $description "Return an infinite lazy list of values starting from n, with each successive value being the result of applying quot to the previous value." } ; { $description "Return an infinite lazy list of values starting from n, with each successive value being the result of applying quot to the previous value." } ;
HELP: lfrom HELP: lfrom
{ $values { "n" integer } { "list" "a lazy list of integers" } } { $values { "n" integer } { "result" "a lazy list of integers" } }
{ $description "Return an infinite lazy list of incrementing integers starting from n." } ; { $description "Return an infinite lazy list of incrementing integers starting from n." } ;
HELP: sequence-tail>list HELP: sequence-tail>list

View File

@ -304,7 +304,7 @@ HELP: vmin
{ $examples { $example "USING: math.vectors prettyprint ;" "{ 1 2 5 } { -7 6 3 } vmin ." "{ -7 2 3 }" } } ; { $examples { $example "USING: math.vectors prettyprint ;" "{ 1 2 5 } { -7 6 3 } vmin ." "{ -7 2 3 }" } } ;
HELP: vclamp HELP: vclamp
{ $values { "v" "a sequence of real numbers" } { "min" "a sequence of real numbers" } { "max" "a sequence of real numbers" } } { $values { "v" "a sequence of real numbers" } { "min" "a sequence of real numbers" } { "max" "a sequence of real numbers" } { "w" "a sequence of real numbers" } }
{ $description "Creates a sequence where each element is clamped to the minimum and maximum elements of the " { $snippet "min" } " and " { $snippet "max" } " sequences." } { $description "Creates a sequence where each element is clamped to the minimum and maximum elements of the " { $snippet "min" } " and " { $snippet "max" } " sequences." }
{ $examples { $examples
{ $example { $example

View File

@ -6,6 +6,7 @@ HELP: (gl-program)
{ $values { $values
{ "shaders" sequence } { "shaders" sequence }
{ "quot" quotation } { "quot" quotation }
{ "program" "a new " { $link gl-program } }
} { $description } { $description
"Creates a gl program and attaches the shaders to it. Then applies the quotation to the program and finally links it." "Creates a gl program and attaches the shaders to it. Then applies the quotation to the program and finally links it."
} }

View File

@ -11,7 +11,7 @@ HELP: +definition+
{ $description "Word that indicates that the dependency is a definition dependency. It is a dependency among two words in which one word depends on the definition of the another. For example, if two words are defined as " { $snippet ": o ( -- ) i ;" } " and " { $snippet ": i ( -- ) ; inline" } ", then 'o' has a definition dependency to 'i' because 'i' is inline. If the definition of 'i' changes 'o' must be recompiled." } ; { $description "Word that indicates that the dependency is a definition dependency. It is a dependency among two words in which one word depends on the definition of the another. For example, if two words are defined as " { $snippet ": o ( -- ) i ;" } " and " { $snippet ": i ( -- ) ; inline" } ", then 'o' has a definition dependency to 'i' because 'i' is inline. If the definition of 'i' changes 'o' must be recompiled." } ;
HELP: add-depends-on-class HELP: add-depends-on-class
{ $values { "obj" classoid } } { $values { "classoid" classoid } }
{ $description "Adds a " { $link +conditional+ } " dependency from the word to the classes mentioned in the classoid." } ; { $description "Adds a " { $link +conditional+ } " dependency from the word to the classes mentioned in the classoid." } ;
HELP: conditional-dependencies HELP: conditional-dependencies

View File

@ -7,7 +7,7 @@ IN: suffix-arrays
HELP: >suffix-array HELP: >suffix-array
{ $values { $values
{ "seq" sequence } { "seq" sequence }
{ "array" array } } { "suffix-array" array } }
{ $description "Creates a suffix array from the input sequence. Suffix arrays are arrays of slices." } ; { $description "Creates a suffix array from the input sequence. Suffix arrays are arrays of slices." } ;
HELP: SA{ HELP: SA{

View File

@ -32,13 +32,13 @@ HELP: TYPED::
{ $example { $example
"USING: kernel math math.libm prettyprint typed ; "USING: kernel math math.libm prettyprint typed ;
IN: scratchpad IN: scratchpad
<<
TYPED:: quadratic-roots ( a: float b: float c: float -- q1: float q2: float ) TYPED:: quadratic-roots ( a: float b: float c: float -- q1: float q2: float )
b neg b neg
b sq 4.0 a * c * - fsqrt b sq 4.0 a * c * - fsqrt
[ + ] [ - ] 2bi [ + ] [ - ] 2bi
[ 2.0 a * / ] bi@ ; [ 2.0 a * / ] bi@ ;
>>
1 0 -9/4 quadratic-roots [ . ] bi@" 1 0 -9/4 quadratic-roots [ . ] bi@"
"1.5 "1.5
-1.5" } } ; -1.5" } } ;

View File

@ -12,14 +12,14 @@ HELP: icon-data
HELP: key-sym HELP: key-sym
{ $values { $values
{ "event" GdkEventKey } { "keyval" GdkEventKey }
{ "sym/f" { $maybe string } } { "string/f" { $maybe string } }
{ "action?" boolean } { "action?" boolean }
} { $description "Gets the key symbol and action indicator from a " { $link GdkEventKey } " struct. If 'action?' is " { $link t } ", then the key is one of the special keys in " { $link codes } "." } ; } { $description "Gets the key symbol and action indicator from a " { $link GdkEventKey } " struct. If 'action?' is " { $link t } ", then the key is one of the special keys in " { $link codes } "." } ;
HELP: on-configure HELP: on-configure
{ $values { $values
{ "win" alien } { "window" alien }
{ "event" alien } { "event" alien }
{ "user-data" alien } { "user-data" alien }
{ "?" boolean } { "?" boolean }

View File

@ -39,7 +39,7 @@ ARTICLE: "vocabs.metadata" "Vocabulary metadata"
ABOUT: "vocabs.metadata" ABOUT: "vocabs.metadata"
HELP: vocab-file-lines HELP: vocab-file-lines
{ $values { "vocab" "a vocabulary specifier" } { "name" string } { "lines" { $maybe { $sequence "lines" } } } } { $values { "vocab" "a vocabulary specifier" } { "name" string } { "lines/f" { $maybe { $sequence "lines" } } } }
{ $description "Outputs the lines of the file named " { $snippet "name" } " from the vocabulary's directory, or " { $link f } " if the file does not exist." } ; { $description "Outputs the lines of the file named " { $snippet "name" } " from the vocabulary's directory, or " { $link f } " if the file does not exist." } ;
HELP: set-vocab-file-lines HELP: set-vocab-file-lines

View File

@ -14,7 +14,7 @@ ARTICLE: "wrap.words" "Word object wrapping"
} ; } ;
HELP: wrap-words HELP: wrap-words
{ $values { "words" { "a sequence of " { $instance wrapping-word } "s" } } { "line-max" integer } { "line-ideal" integer } { "lines" "a sequence of sequences of words" } } { $values { "words" { "a sequence of " { $instance wrapping-word } "s" } } { "width" integer } { "lines" "a sequence of sequences of words" } }
{ $description "Divides the words into lines, where the sum of the lengths of the words on a line (not counting breaks at the end of the line) is at most the given maximum. The returned set of lines is optimized to minimize the square of the deviation of each line from the ideal width. It is not guaranteed to be the minimal number of lines. Every line except for the first one starts with a non-break, and every one but the last ends with a break." } ; { $description "Divides the words into lines, where the sum of the lengths of the words on a line (not counting breaks at the end of the line) is at most the given maximum. The returned set of lines is optimized to minimize the square of the deviation of each line from the ideal width. It is not guaranteed to be the minimal number of lines. Every line except for the first one starts with a non-break, and every one but the last ends with a break." } ;
HELP: wrapping-word HELP: wrapping-word

View File

@ -1,6 +1,6 @@
! Copyright (C) 2009 Daniel Ehrenberg ! Copyright (C) 2009 Daniel Ehrenberg
! See http://factorcode.org/license.txt for BSD license. ! See http://factorcode.org/license.txt for BSD license.
USING: help.syntax help.markup strings math kernel ; USING: arrays help.markup help.syntax kernel math strings ;
IN: wrap IN: wrap
ABOUT: "wrap" ABOUT: "wrap"
@ -19,5 +19,5 @@ HELP: element
} ; } ;
HELP: wrap HELP: wrap
{ $values { "elements" { $sequence element } } { "width" real } } { $values { "elements" { $sequence element } } { "width" real } { "array" array } }
{ $description "Break the " { $snippet "elements" } " into lines such that the total width of each line tries to be less than " { $snippet "width" } " while attempting to minimize the raggedness represented by the amount of space at the end of each line. Returns an array of lines." } ; { $description "Break the " { $snippet "elements" } " into lines such that the total width of each line tries to be less than " { $snippet "width" } " while attempting to minimize the raggedness represented by the amount of space at the end of each line. Returns an array of lines." } ;

View File

@ -95,7 +95,7 @@ HELP: c-ptr
{ $class-description "Class of objects consisting of aliens, byte arrays and " { $link f } ". These objects all can be used as values of " { $link pointer } " C types." } ; { $class-description "Class of objects consisting of aliens, byte arrays and " { $link f } ". These objects all can be used as values of " { $link pointer } " C types." } ;
HELP: alien-invoke HELP: alien-invoke
{ $values { "args..." "zero or more objects passed to the C function" } { "return" "a C return type" } { "library" "a logical library name" } { "function" "a C function name" } { "parameters" "a sequence of C parameter types" } { "return..." "the return value of the function, if not " { $link void } } } { $values { "args..." "zero or more objects passed to the C function" } { "return" "a C return type" } { "library" "a logical library name" } { "function" "a C function name" } { "parameters" "a sequence of C parameter types" } { "varargs?" boolean } { "return..." "the return value of the function, if not " { $link void } } }
{ $description "Calls a C library function with the given name. Input parameters are taken from the data stack, and the return value is pushed on the data stack after the function returns. A return type of " { $link void } " indicates that no value is to be expected." } { $description "Calls a C library function with the given name. Input parameters are taken from the data stack, and the return value is pushed on the data stack after the function returns. A return type of " { $link void } " indicates that no value is to be expected." }
{ $notes "C type names are documented in " { $link "c-types-specs" } "." } { $notes "C type names are documented in " { $link "c-types-specs" } "." }
{ $errors "Throws an " { $link callsite-not-compiled } " if the word calling " { $link alien-invoke } " was not compiled with the optimizing compiler." } ; { $errors "Throws an " { $link callsite-not-compiled } " if the word calling " { $link alien-invoke } " was not compiled with the optimizing compiler." } ;

View File

@ -455,7 +455,7 @@ HELP: bad-superclass
{ $error-description "Thrown if an attempt is made to subclass a class that is not a tuple class, or a tuple class declared " { $link POSTPONE: final } "." } ; { $error-description "Thrown if an attempt is made to subclass a class that is not a tuple class, or a tuple class declared " { $link POSTPONE: final } "." } ;
HELP: ?offset-of-slot HELP: ?offset-of-slot
{ $values { "name" string } { "tuple" tuple } { "n" { $maybe integer } } } { $values { "name" string } { "tuple" tuple } { "n/f" { $maybe integer } } }
{ $description "Returns the offset of a tuple slot accessed by " { $snippet "name" } ", or " { $link f } " if no slot with that name." } ; { $description "Returns the offset of a tuple slot accessed by " { $snippet "name" } ", or " { $link f } " if no slot with that name." } ;
HELP: offset-of-slot HELP: offset-of-slot

View File

@ -794,7 +794,7 @@ HELP: curried
{ curry curried compose prepose composed } related-words { curry curried compose prepose composed } related-words
HELP: 2curry HELP: 2curry
{ $values { "obj1" object } { "obj2" object } { "quot" callable } { "curry" curried } } { $values { "obj1" object } { "obj2" object } { "quot" callable } { "curried" curried } }
{ $description "Outputs a " { $link callable } " which pushes " { $snippet "obj1" } " and " { $snippet "obj2" } " and then calls " { $snippet "quot" } "." } { $description "Outputs a " { $link callable } " which pushes " { $snippet "obj1" } " and " { $snippet "obj2" } " and then calls " { $snippet "quot" } "." }
{ $notes "This operation is efficient and does not copy the quotation." } { $notes "This operation is efficient and does not copy the quotation." }
{ $examples { $examples
@ -802,12 +802,12 @@ HELP: 2curry
} ; } ;
HELP: 3curry HELP: 3curry
{ $values { "obj1" object } { "obj2" object } { "obj3" object } { "quot" callable } { "curry" curried } } { $values { "obj1" object } { "obj2" object } { "obj3" object } { "quot" callable } { "curried" curried } }
{ $description "Outputs a " { $link callable } " which pushes " { $snippet "obj1" } ", " { $snippet "obj2" } " and " { $snippet "obj3" } ", and then calls " { $snippet "quot" } "." } { $description "Outputs a " { $link callable } " which pushes " { $snippet "obj1" } ", " { $snippet "obj2" } " and " { $snippet "obj3" } ", and then calls " { $snippet "quot" } "." }
{ $notes "This operation is efficient and does not copy the quotation." } ; { $notes "This operation is efficient and does not copy the quotation." } ;
HELP: with HELP: with
{ $values { "param" object } { "obj" object } { "quot" { $quotation ( param elt -- ... ) } } { "curry" curried } } { $values { "param" object } { "obj" object } { "quot" { $quotation ( param elt -- ... ) } } { "curried" curried } }
{ $description "Partial application on the left. The following two lines are equivalent:" { $description "Partial application on the left. The following two lines are equivalent:"
{ $code "swap [ swap A ] curry B" } { $code "swap [ swap A ] curry B" }
{ $code "[ A ] with B" } { $code "[ A ] with B" }
@ -825,7 +825,7 @@ HELP: 2with
{ "param2" object } { "param2" object }
{ "obj" object } { "obj" object }
{ "quot" { $quotation ( param1 param2 elt -- ... ) } } { "quot" { $quotation ( param1 param2 elt -- ... ) } }
{ "curry" curried } { "curried" curried }
} }
{ $description "Partial application on the left of two parameters." } ; { $description "Partial application on the left of two parameters." } ;
@ -842,7 +842,7 @@ HELP: compose
} ; } ;
HELP: prepose HELP: prepose
{ $values { "quot1" callable } { "quot2" callable } { "compose" composed } } { $values { "quot1" callable } { "quot2" callable } { "composed" composed } }
{ $description "Quotation composition. Outputs a " { $link callable } " which calls " { $snippet "quot2" } " followed by " { $snippet "quot1" } "." } { $description "Quotation composition. Outputs a " { $link callable } " which calls " { $snippet "quot2" } " followed by " { $snippet "quot1" } "." }
{ $notes "See " { $link compose } " for details." } ; { $notes "See " { $link compose } " for details." } ;

View File

@ -277,7 +277,7 @@ HELP: if-zero
HELP: when-zero HELP: when-zero
{ $values { $values
{ "n" number } { "quot" "the first quotation of an " { $link if-zero } } } { "n" number } { "quot" "the first quotation of an " { $link if-zero } } { "x" object } }
{ $description "Makes an implicit check if the number is zero. A zero is dropped and the " { $snippet "quot" } " is called." } { $description "Makes an implicit check if the number is zero. A zero is dropped and the " { $snippet "quot" } " is called." }
{ $examples "This word is equivalent to " { $link if-zero } " with an empty second quotation:" { $examples "This word is equivalent to " { $link if-zero } " with an empty second quotation:"
{ $example { $example

View File

@ -1210,12 +1210,12 @@ HELP: supremum
{ min max supremum infimum } related-words { min max supremum infimum } related-words
HELP: shortest HELP: shortest
{ $values { "seq" sequence } { "elt" object } } { $values { "seqs" sequence } { "elt" object } }
{ $description "Outputs the shortest element of " { $snippet "seq" } "." } ; { $description "Outputs the shortest sequence from " { $snippet "seqs" } "." } ;
HELP: longest HELP: longest
{ $values { "seq" sequence } { "elt" object } } { $values { "seqs" sequence } { "elt" object } }
{ $description "Outputs the longest element of " { $snippet "seq" } "." } ; { $description "Outputs the longest sequence from " { $snippet "seqs" } "." } ;
{ shortest longest } related-words { shortest longest } related-words

View File

@ -20,7 +20,7 @@ HELP: write-ctags
} ; } ;
HELP: ctags HELP: ctags
{ $values { "alist" "ctags" } } { $values { "ctags" "alist" } }
{ $description "Make a sequence of ctags from " { $link all-words } ", sorted by word name." } ; { $description "Make a sequence of ctags from " { $link all-words } ", sorted by word name." } ;
ABOUT: "ctags" ABOUT: "ctags"

View File

@ -6,7 +6,7 @@ HELP: article-parents
{ $description "All the parent articles for the article and ensures that the ancestor always is 'handbook'." } ; { $description "All the parent articles for the article and ensures that the ancestor always is 'handbook'." } ;
HELP: get-article HELP: get-article
{ $values { "name" string } { "str" string } } { $values { "name" string } { "element" string } }
{ $description "If an article and a vocab share name, we render the vocab instead." } ; { $description "If an article and a vocab share name, we render the vocab instead." } ;
HELP: find-word HELP: find-word

View File

@ -31,6 +31,7 @@ HELP: <vertex-array-object>
{ "vertex-buffer" "a vertex buffer" } { "vertex-buffer" "a vertex buffer" }
{ "program-instance" program-instance } { "program-instance" program-instance }
{ "format" vertex-format } { "format" vertex-format }
{ "vertex-array" vertex-array }
} }
{ $description "Creates a new vertex array object." } ; { $description "Creates a new vertex array object." } ;

View File

@ -77,7 +77,7 @@ HELP: odbc-number-of-columns
HELP: odbc-describe-column HELP: odbc-describe-column
{ $values { $values
{ "statement" "an ODBC statement handle" } { "statement" "an ODBC statement handle" }
{ "n" "a column number starting from one" } { "columnNumber" "a column number starting from one" }
{ "column" "a column object" } { "column" "a column object" }
} }
{ $description { $description
@ -88,7 +88,7 @@ HELP: odbc-describe-column
HELP: odbc-get-field HELP: odbc-get-field
{ $values { $values
{ "statement" "an ODBC statement handle" } { "statement" "an ODBC statement handle" }
{ "column" "a column number starting from one or a <column> object" } { "column!" "a column number starting from one or a <column> object" }
{ "field" "a <field> object" } { "field" "a <field> object" }
} }
{ $description { $description

View File

@ -6,7 +6,7 @@ USING: help.markup help.syntax successor strings ;
IN: succesor IN: succesor
HELP: successor HELP: successor
{ $values { "str" string } } { $values { "str" string } { "str'" string } }
{ $description { $description
"Returns the successor to " { $snippet "str" } ". The successor is calculated by incrementing characters starting from the rightmost alphanumeric (or the rightmost character if there are no alphanumerics) in the string. Incrementing a digit always results in another digit, and incrementing a letter results in another letter of the same case. " "Returns the successor to " { $snippet "str" } ". The successor is calculated by incrementing characters starting from the rightmost alphanumeric (or the rightmost character if there are no alphanumerics) in the string. Incrementing a digit always results in another digit, and incrementing a letter results in another letter of the same case. "
$nl $nl

View File

@ -177,14 +177,14 @@ HELP: first-key
HELP: pop-tree-left HELP: pop-tree-left
{ $values { $values
{ "tree" tree } { "tree" tree }
{ "pair/f" { $maybe pair } } { "node/f" { $maybe pair } }
} }
{ $description "Removes and returns a key-value mapping associated with the lowest key in this map, or " { $link f } " if the map is empty." } ; { $description "Removes and returns a key-value mapping associated with the lowest key in this map, or " { $link f } " if the map is empty." } ;
HELP: pop-tree-right HELP: pop-tree-right
{ $values { $values
{ "tree" tree } { "tree" tree }
{ "pair/f" { $maybe pair } } { "node/f" { $maybe pair } }
} }
{ $description "Removes and returns a key-value mapping associated with the highest key in this map, or " { $link f } " if the map is empty." } ; { $description "Removes and returns a key-value mapping associated with the highest key in this map, or " { $link f } " if the map is empty." } ;

View File

@ -57,6 +57,12 @@ $nl
HELP: y-at HELP: y-at
{ $description "Given two points on a straight line and an " { $snippet "x" } " coordinate, calculate the " { $snippet "y" } " coordinate at " { $snippet "x" } " on that line." } { $description "Given two points on a straight line and an " { $snippet "x" } " coordinate, calculate the " { $snippet "y" } " coordinate at " { $snippet "x" } " on that line." }
{ $values
{ "x" object }
{ "point1" object }
{ "point2" object }
{ "y" object }
}
{ $examples { $examples
{ $example { $example
"USING: ui.gadgets.charts.lines.private prettyprint ;" "USING: ui.gadgets.charts.lines.private prettyprint ;"
@ -77,6 +83,12 @@ HELP: y-at
HELP: calc-x HELP: calc-x
{ $description "Given the " { $snippet "slope" } " of a line and a random " { $snippet "point" } " belonging to that line, calculate the " { $snippet "x" } " coordinate corresponding to the given " { $snippet "y" } "." } { $description "Given the " { $snippet "slope" } " of a line and a random " { $snippet "point" } " belonging to that line, calculate the " { $snippet "x" } " coordinate corresponding to the given " { $snippet "y" } "." }
{ $values
{ "slope" object }
{ "y" object }
{ "point" object }
{ "x" object }
}
{ $examples { $examples
{ $example { $example
"USING: ui.gadgets.charts.lines.private prettyprint ;" "USING: ui.gadgets.charts.lines.private prettyprint ;"
@ -92,6 +104,12 @@ HELP: calc-x
HELP: calc-y HELP: calc-y
{ $description "Given the " { $snippet "slope" } " of a line and a random " { $snippet "point" } " belonging to that line, calculate the " { $snippet "y" } " coordinate corresponding to the given " { $snippet "x" } "." } { $description "Given the " { $snippet "slope" } " of a line and a random " { $snippet "point" } " belonging to that line, calculate the " { $snippet "y" } " coordinate corresponding to the given " { $snippet "x" } "." }
{ $values
{ "slope" object }
{ "x" object }
{ "point" object }
{ "y" object }
}
{ $examples { $examples
{ $example { $example
"USING: ui.gadgets.charts.lines.private prettyprint ;" "USING: ui.gadgets.charts.lines.private prettyprint ;"
@ -107,6 +125,11 @@ HELP: calc-y
HELP: calc-line-slope HELP: calc-line-slope
{ $description "Given the two points belonging to a straight line, calculate the " { $snippet "slope" } " of the line, assuming the line equation is " { $snippet "y(x) = slope * x + b" } "." { $description "Given the two points belonging to a straight line, calculate the " { $snippet "slope" } " of the line, assuming the line equation is " { $snippet "y(x) = slope * x + b" } "."
{ $values
{ "point1" object }
{ "point2" object }
{ "slope" object }
}
$nl $nl
"The formula for the calculation is " { $snippet "slope = (y1-y2) / (x1-x2)" } ", therefore it'll throw a division by zero error if both points have the same " { $snippet "x" } " coordinate." } "The formula for the calculation is " { $snippet "slope = (y1-y2) / (x1-x2)" } ", therefore it'll throw a division by zero error if both points have the same " { $snippet "x" } " coordinate." }
{ $examples { $examples