]> gitweb.factorcode.org Git - factor.git/blobdiff - basis/persistent/heaps/heaps-docs.factor
fix typo in heaps-docs.factor
[factor.git] / basis / persistent / heaps / heaps-docs.factor
index a56022a039876be7b61cc33e91868e4e0c9c5b12..5ca92abe330a3a9d4f09d719536dacc51c285bee 100644 (file)
@@ -10,15 +10,15 @@ HELP: <singleton-heap>
 { $description "Creates a new persistent heap consisting of one object with the given priority." } ;
 
 HELP: pheap-empty?
-{ $values { "heap" "a persistent heap" } { "?" "a boolean" } }
+{ $values { "heap" "a persistent heap" } { "?" boolean } }
 { $description "Returns true if this is an empty persistent heap." } ;
 
 HELP: pheap-peek
 { $values { "heap" "a persistent heap" } { "value" "an object in the heap" } { "prio" "the minimum priority" } }
-{ $description "Gets the object in the heap with minumum priority." } ;
+{ $description "Gets the object in the heap with minimum priority." } ;
 
 HELP: pheap-push
-{ $values { "heap" "a persistent heap" } { "value" object } { "prio" "a priority" } { "newheap" "a new persistent heap" } }
+{ $values { "value" object } { "prio" "a priority" } { "heap" "a persistent heap" } { "newheap" "a new persistent heap" } }
 { $description "Creates a new persistent heap also containing the given object of the given priority." } ;
 
 HELP: pheap-pop*
@@ -43,16 +43,20 @@ HELP: pheap>values
 
 ARTICLE: "persistent-heaps" "Persistent heaps"
 "This vocabulary implements persistent minheaps, aka priority queues. They are purely functional and support efficient O(log n) operations of pushing and popping, with O(1) time access to the minimum element. To create heaps, use the following words:"
-{ $subsection <persistent-heap> }
-{ $subsection <singleton-heap> }
+{ $subsections
+    <persistent-heap>
+    <singleton-heap>
+}
 "To manipulate them:"
-{ $subsection pheap-peek }
-{ $subsection pheap-push }
-{ $subsection pheap-pop }
-{ $subsection pheap-pop* }
-{ $subsection pheap-empty? }
-{ $subsection assoc>pheap }
-{ $subsection pheap>alist }
-{ $subsection pheap>values } ;
+{ $subsections
+    pheap-peek
+    pheap-push
+    pheap-pop
+    pheap-pop*
+    pheap-empty?
+    assoc>pheap
+    pheap>alist
+    pheap>values
+} ;
 
 ABOUT: "persistent-heaps"