From f240e6c0ab43dc051f9d141c00dc0b3bec338978 Mon Sep 17 00:00:00 2001 From: Doug Coleman Date: Sat, 11 Mar 2023 07:12:10 -0600 Subject: [PATCH] docs: fix spacing --- basis/db/db-docs.factor | 36 +++++++++---------- basis/editors/editors-docs.factor | 2 +- basis/furnace/asides/asides-docs.factor | 4 +-- basis/help/tour/tour.factor | 6 ++-- .../generalizations-docs.factor | 2 +- .../suffix-arrays/suffix-arrays-tests.factor | 2 +- basis/threads/threads-docs.factor | 2 +- core/math/parser/parser-tests.factor | 2 +- 8 files changed, 28 insertions(+), 28 deletions(-) diff --git a/basis/db/db-docs.factor b/basis/db/db-docs.factor index 0b096e0d01..44a708ceb3 100644 --- a/basis/db/db-docs.factor +++ b/basis/db/db-docs.factor @@ -39,8 +39,8 @@ HELP: result-set HELP: new-result-set { $values - { "query" "a query" } { "handle" alien } { "class" class } - { "result-set" result-set } } + { "query" "a query" } { "handle" alien } { "class" class } + { "result-set" result-set } } { $description "Creates a new " { $link result-set } " object of type " { $snippet "class" } "." } ; HELP: new-statement @@ -49,12 +49,12 @@ HELP: new-statement HELP: bind-statement { $values - { "obj" object } { "statement" statement } } + { "obj" object } { "statement" statement } } { $description "Sets the statement's " { $slot "bind-params" } " and calls " { $link bind-statement* } " to do the database-specific bind. Sets " { $slot "bound?" } " to true if binding succeeds." } ; HELP: bind-statement* { $values - { "statement" statement } } + { "statement" statement } } { $description "Does a low-level bind of the SQL statement's tuple parameters if the database requires. Some databases should treat this as a no-op and bind instead when the actual statement is run." } ; HELP: @@ -74,7 +74,7 @@ HELP: prepare-statement HELP: low-level-bind { $values - { "statement" statement } } + { "statement" statement } } { $description "For use with prepared statements, methods on this word should bind the datatype in the SQL spec to its identifier in the SQL string. To name bound variables, SQLite uses identifiers in the form of " { $snippet ":name" } ", while PostgreSQL uses increasing numbers beginning with a dollar sign, e.g. " { $snippet "$1" } "." } ; HELP: query-results @@ -123,18 +123,18 @@ HELP: in-transaction HELP: in-transaction? { $values - { "?" boolean } } + { "?" boolean } } { $description "Returns true if there is currently a transaction in progress in this scope." } ; HELP: query-each { $values - { "result-set" result-set } { "quot" quotation } } + { "result-set" result-set } { "quot" quotation } } { $description "Applies the quotation to each row of the " { $link result-set } " in order." } ; HELP: query-map { $values - { "result-set" result-set } { "quot" quotation } - { "seq" sequence } } + { "result-set" result-set } { "quot" quotation } + { "seq" sequence } } { $description "Applies the quotation to each row of the " { $link result-set } " in order." } ; HELP: rollback-transaction @@ -142,39 +142,39 @@ HELP: rollback-transaction HELP: sql-command { $values - { "sql" string } } + { "sql" string } } { $description "Executes an SQL string using the database in the " { $link db-connection } " symbol." } ; HELP: sql-query { $values - { "sql" string } - { "rows" "an array of arrays of strings" } } + { "sql" string } + { "rows" "an array of arrays of strings" } } { $description "Runs an SQL query of raw text in the database in the " { $link db-connection } " symbol. Each row is returned as an array of strings; no type-conversions are done on the resulting data." } ; { sql-command sql-query } related-words HELP: sql-row { $values - { "result-set" result-set } - { "seq" sequence } } + { "result-set" result-set } + { "seq" sequence } } { $description "Returns the current row in a " { $link result-set } " as an array of strings." } ; HELP: sql-row-typed { $values - { "result-set" result-set } - { "seq" sequence } } + { "result-set" result-set } + { "seq" sequence } } { $description "Returns the current row in a " { $link result-set } " as an array of typed Factor objects." } ; { sql-row sql-row-typed } related-words HELP: with-db { $values - { "db" "a database configuration object" } { "quot" quotation } } + { "db" "a database configuration object" } { "quot" quotation } } { $description "Calls the quotation with a database bound to the " { $link db-connection } " symbol. See " { $link "db-custom-database-combinators" } " for help setting up database access." } ; HELP: with-transaction { $values - { "quot" quotation } } + { "quot" quotation } } { $description "Calls the quotation inside a database transaction and commits the result to the database after the quotation finishes. If the quotation throws an error, the transaction is aborted." } ; ARTICLE: "db" "Database library" diff --git a/basis/editors/editors-docs.factor b/basis/editors/editors-docs.factor index 38405f6788..356aa76bbc 100644 --- a/basis/editors/editors-docs.factor +++ b/basis/editors/editors-docs.factor @@ -32,7 +32,7 @@ $nl "a child process." } } $nl -"Every editor is required to reserve its own " { $link editor-class } ". For example:" +"Every editor is required to reserve its own " { $link editor-class } ". For example:" { $code "SINGLETON: foo" } { $link editor-class } " will be set to this singleton when Factor is set to use your editor of" " choice. Now, we will define words that will dispatch when the editor class is set to " diff --git a/basis/furnace/asides/asides-docs.factor b/basis/furnace/asides/asides-docs.factor index 099ff80ad4..a424cdd2cf 100644 --- a/basis/furnace/asides/asides-docs.factor +++ b/basis/furnace/asides/asides-docs.factor @@ -4,8 +4,8 @@ IN: furnace.asides HELP: { $values - { "responder" "a responder" } - { "responder'" "a new responder" } + { "responder" "a responder" } + { "responder'" "a new responder" } } { $description "Creates a new " { $link asides } " responder wrapping an existing responder." } ; diff --git a/basis/help/tour/tour.factor b/basis/help/tour/tour.factor index 614bd9a26d..3acb1bb063 100644 --- a/basis/help/tour/tour.factor +++ b/basis/help/tour/tour.factor @@ -639,9 +639,9 @@ them, which are embodied in the listener. Many functions of the listener can be You have seen some examples of this: { $list - { "The help is navigable online, but you can also invoke it with " { $link help } " and print help items with " { $link print-content } " ; " } - { "The " { $snippet "F2" } " shortcut or the words " { $link refresh } " and " { $link refresh-all } " can be used to refresh vocabularies from disk while continuing working in the listener; " } - { "The " { $link edit } " word gives you editor integration, but you can also click on file names in the help pages for vocabularies to open them. " } + { "The help is navigable online, but you can also invoke it with " { $link help } " and print help items with " { $link print-content } " ; " } + { "The " { $snippet "F2" } " shortcut or the words " { $link refresh } " and " { $link refresh-all } " can be used to refresh vocabularies from disk while continuing working in the listener;" } + { "The " { $link edit } " word gives you editor integration, but you can also click on file names in the help pages for vocabularies to open them." } } The refresh is an efficient mechanism. Whenever a word is redefined, words that depend on it are recompiled against the new diff --git a/basis/sequences/generalizations/generalizations-docs.factor b/basis/sequences/generalizations/generalizations-docs.factor index 5962921e5c..1e14726913 100644 --- a/basis/sequences/generalizations/generalizations-docs.factor +++ b/basis/sequences/generalizations/generalizations-docs.factor @@ -50,7 +50,7 @@ HELP: firstn HELP: ?firstn { $values { "n" integer } } -{ $description "A generalization of " { $link ?first } " that pushes the first " { $snippet "n" } " elements of a sequence on the stack, or " { $link f } " if the sequence is shorter than the requested number of elements." } +{ $description "A generalization of " { $link ?first } " that pushes the first " { $snippet "n" } " elements of a sequence on the stack, or " { $link f } " if the sequence is shorter than the requested number of elements." } { $examples "Some core words expressed in terms of " { $link ?firstn } ":" { $table diff --git a/basis/suffix-arrays/suffix-arrays-tests.factor b/basis/suffix-arrays/suffix-arrays-tests.factor index 3240fe3182..dfc49cc687 100644 --- a/basis/suffix-arrays/suffix-arrays-tests.factor +++ b/basis/suffix-arrays/suffix-arrays-tests.factor @@ -4,7 +4,7 @@ USING: tools.test suffix-arrays kernel namespaces sequences ; ! built from [ all-words 10 head [ name>> ] map ] { } [ - { + { "run-tests" "must-fail-with" "test-all" diff --git a/basis/threads/threads-docs.factor b/basis/threads/threads-docs.factor index 780875cbe8..d8770b393a 100644 --- a/basis/threads/threads-docs.factor +++ b/basis/threads/threads-docs.factor @@ -175,7 +175,7 @@ HELP: spawn $nl "The new thread begins with an empty data stack, an empty retain stack, and an empty catch stack. The name stack is inherited from the parent thread but may be cleared with " { $link init-namestack } "." } { $notes - "The recommended way to pass data to the new thread is to explicitly construct a quotation containing the data, for example using " { $link curry } " or " { $link compose } "." + "The recommended way to pass data to the new thread is to explicitly construct a quotation containing the data, for example using " { $link curry } " or " { $link compose } "." } { $examples "A simple thread that adds two numbers:" diff --git a/core/math/parser/parser-tests.factor b/core/math/parser/parser-tests.factor index cb1b2653bc..e14a801ca5 100644 --- a/core/math/parser/parser-tests.factor +++ b/core/math/parser/parser-tests.factor @@ -198,7 +198,7 @@ unit-test [ 2+1/2 -1 >base ] [ invalid-radix? ] must-fail-with [ 123.456 7 >base ] [ invalid-radix? ] must-fail-with -{ "0/0." } [ 0/0. number>string ] unit-test +{ "0/0." } [ 0/0. number>string ] unit-test { "-0/0." } [ -0/0. number>string ] unit-test { t } [ "0/0." string>number fp-nan? ] unit-test -- 2.34.1