steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

threads: cleanup docs for $slots.

master
John Benediktsson 2020-05-27 09:47:29 -07:00
parent 0fb44180c0
commit 10e19a3944
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
basis/threads/threads-docs.factor
View 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." }
}
}
} ;