From 7751d49ffedfb1cae5837b3c1abb2ba993f338ee Mon Sep 17 00:00:00 2001 From: Slava Pestov Date: Mon, 5 Nov 2007 11:11:48 -0500 Subject: [PATCH] Doc fixes --- core/dlists/dlists-docs.factor | 2 ++ core/threads/threads-docs.factor | 6 +++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/core/dlists/dlists-docs.factor b/core/dlists/dlists-docs.factor index a20d038621..5a808a9a5d 100644 --- a/core/dlists/dlists-docs.factor +++ b/core/dlists/dlists-docs.factor @@ -6,6 +6,8 @@ ARTICLE: "dlists" "Doubly-linked lists" $nl "While nodes can be modified directly, the fundamental protocol support by doubly-linked lists is that of a double-ended queue with a few additional operations. Elements can be added or removed at both ends of the dlist in constant time." $nl +"When using a dlist as a simple queue, the convention is to queue elements with " { $link push-front } " and dequeue them with " { $link pop-back } "." +$nl "Dlists form a class:" { $subsection dlist } { $subsection dlist? } diff --git a/core/threads/threads-docs.factor b/core/threads/threads-docs.factor index ccd25c8e3f..181979bfed 100644 --- a/core/threads/threads-docs.factor +++ b/core/threads/threads-docs.factor @@ -1,5 +1,5 @@ USING: help.markup help.syntax kernel kernel.private io -threads.private continuations ; +threads.private continuations dlists ; IN: threads ARTICLE: "threads" "Threads" @@ -20,8 +20,8 @@ $nl ABOUT: "threads" HELP: run-queue -{ $values { "queue" queue } } -{ $description "Outputs the runnable thread queue." } ; +{ $values { "queue" dlist } } +{ $description "Outputs the runnable thread queue. By convention, continuations are queued with " { $link push-front } " and dequeued with " { $link pop-back } "." } ; HELP: schedule-thread { $values { "continuation" "a continuation reified by " { $link callcc0 } } }