]> gitweb.factorcode.org Git - factor.git/commitdiff
threads: cleanup docs for $slots.
authorJohn Benediktsson <mrjbq7@gmail.com>
Wed, 27 May 2020 16:47:29 +0000 (09:47 -0700)
committerJohn Benediktsson <mrjbq7@gmail.com>
Wed, 27 May 2020 16:59:42 +0000 (09:59 -0700)
basis/threads/threads-docs.factor

index 43b7e8e61a014d966933a272cec181bb6b1bb066..9b2c0708e9da70dc21ec71528fce1e5e76b7f2f0 100644 (file)
@@ -72,34 +72,34 @@ ABOUT: "threads"
 
 HELP: thread
 { $class-description "A thread. The slots are as follows:"
-    { $list
+    { $slots
       {
-          { $snippet "id" }
-          " - a unique identifier assigned to each thread."
+          "id"
+          "a unique identifier assigned to each thread."
       }
       {
-          { $snippet "exit-handler" }
-          " - a " { $link quotation } " run when the thread is being stopped."
+          "exit-handler"
+          { "a " { $link quotation } " run when the thread is being stopped." }
       }
       {
-          { $snippet "name" }
-          " - the name passed to " { $link spawn } "."
+          "name"
+          { "the name passed to " { $link spawn } "." }
       }
       {
-          { $snippet "quot" }
-          " - the initial quotation passed to " { $link spawn } "."
+          "quot"
+          { "the initial quotation passed to " { $link spawn } "." }
       }
       {
-          { $snippet "runnable" }
-          " - whether the thread is runnable. Initially it is, " { $link f } "."
+          "runnable"
+          { "whether the thread is runnable. Initially it is, " { $link f } "." }
       }
       {
-          { $snippet "state" }
-          " - a " { $link string } " indicating what the thread is waiting for, or " { $link f } ". This slot is intended to be used for debugging purposes."
+          "state"
+          { "a " { $link string } " indicating what the thread is waiting for, or " { $link f } ". This slot is intended to be used for debugging purposes." }
       }
       {
-          { $snippet "context" }
-          " - a " { $link box } " holding an alien pointer to the threads " { $link context } " object."
+          "context"
+          { "a " { $link box } " holding an alien pointer to the threads " { $link context } " object." }
       }
     }
 } ;