factor: clean up whitespace in -docs files

db4
Doug Coleman 2015-07-02 10:31:22 -07:00
parent d47f9447c3
commit e3cb325040
154 changed files with 378 additions and 415 deletions

View File

@ -37,4 +37,3 @@ HELP: ?V{
{ $values { "elements" "a list of booleans" } }
{ $description "Marks the beginning of a literal bit vector. Literal bit vectors are terminated by " { $link POSTPONE: } } "." }
{ $examples { $code "?V{ t f t }" } } ;

View File

@ -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>> } "." } ;

View File

@ -8,4 +8,3 @@ HELP: CF>array
HELP: <CFArray>
{ $values { "seq" "a sequence of " { $link alien } " instances" } { "alien" "a " { $snippet "CFArray" } } }
{ $description "Creates a Core Foundation array from a Factor array." } ;

View File

@ -8,4 +8,3 @@ HELP: <CFBundle>
HELP: load-framework
{ $values { "name" "a pathname string" } }
{ $description "Loads a Core Foundation framework." } ;

View File

@ -26,4 +26,3 @@ HELP: utf32
{ $see-also "encodings-introduction" } ;
{ utf32 utf32le utf32be } related-words

View File

@ -82,4 +82,3 @@ ARTICLE: "network-icmp" "ICMP"
} ;
ABOUT: "network-icmp"

View File

@ -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." } ;

View File

@ -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." } ;

View File

@ -87,5 +87,3 @@ ARTICLE: "opengl-modeling-transformations" "Modeling transformations"
{ glTranslatef glTranslated glRotatef glRotated glScalef glScaled }
related-words

View File

@ -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" } "." } ;

View File

@ -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 } ;

View File

@ -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"

View File

@ -120,4 +120,3 @@ $nl
"gl-utilities"
"text-rendering"
} ;

View File

@ -45,5 +45,3 @@ $nl
;
ABOUT: "uuid"

View File

@ -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." } ;

View File

@ -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" } ;

View File

@ -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 } "." } ;

View File

@ -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 ;

View File

@ -509,4 +509,3 @@ $nl
{ $see-also "integers" "rationals" "floats" "complex-numbers" } ;
ABOUT: "arithmetic"

View File

@ -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." } ;

View File

@ -267,5 +267,3 @@ HELP: list-transactions
"This requires a patched bitcoin server so may not work with old or unpatched "
"servers."
} ;

View File

@ -20,5 +20,3 @@ HELP: cond-case
"zero"
}
} ;

View File

@ -65,4 +65,3 @@ HELP: push-current-model
HELP: line>obj
{ $values { "line" string } }
{ $description "Process a line from the object file within the current parsing context." } ;

View File

@ -33,4 +33,3 @@ HELP: ini>string
{ $description
"Encodes the specified " { $link hashtable } " as an INI configuration."
} ;

View File

@ -17,4 +17,3 @@ HELP: exp-int
HELP: stirling-fact
{ $values { "n" integer } { "fact" integer } }
{ $description "James Stirling's factorial approximation." } ;

View File

@ -12,4 +12,3 @@ HELP: binpack
HELP: map-binpack
{ $values { "items" sequence } { "quot" { $quotation ( item -- weight ) } } { "#bins" "number of bins" } { "bins" "packed bins" } }
{ $description "Packs a sequence of items into the specified number of bins, using the quotation to determine the weight." } ;

View File

@ -165,4 +165,3 @@ HELP: zvector{
POSTPONE: svector{ POSTPONE: dvector{
POSTPONE: cvector{ POSTPONE: zvector{
} related-words

View File

@ -12,4 +12,3 @@ HELP: rev-haar
{ $description "Reverse Haar wavelet transform function." }
{ $notes "The sequence length should be a power of two." }
{ $examples { $example "USING: math.transforms.haar prettyprint ;" "{ 3 2 -1 -2 3 0 4 1 } rev-haar ." "{ 7 1 6 6 3 -5 4 2 }" } } ;

View File

@ -120,4 +120,3 @@ HELP: m/quit
{ $description
"Close the connection to the " { $link memcached-server } "."
} ;

View File

@ -272,5 +272,3 @@ HELP: with-db
{ "quot" "quotation to execute with the given mdb instance as context" }
}
{ $description "executes a quotation with the given mdb instance in its context" } ;

View File

@ -10,4 +10,3 @@ HELP: <ntp>
{ $description
"Requests the time from the specified NTP time server."
} ;

View File

@ -12,4 +12,3 @@ H{ "foo" => 1 "bar" => 2 } ."""
"""H{ { "foo" 1 } { "bar" 2 } }""" }
}
;