]> gitweb.factorcode.org Git - factor.git/blobdiff - basis/boxes/boxes-docs.factor
core, basis, extra: Remove DOS line endings from files.
[factor.git] / basis / boxes / boxes-docs.factor
index 5c0514b2132e49f6b4574d719cdd7f2c6b350ee4..a72d8e082db92932a440a07d7586bc613ea0f590 100644 (file)
@@ -1,39 +1,39 @@
-USING: help.markup help.syntax kernel ;\r
-IN: boxes\r
-\r
-HELP: box\r
-{ $class-description "A data type holding a single value in the " { $snippet "value" } " slot. The " { $snippet "occupied" } " slot indicates if the value is set." } ;\r
-\r
-HELP: <box>\r
-{ $values { "box" box } }\r
-{ $description "Creates a new empty box." } ;\r
-\r
-HELP: >box\r
-{ $values { "value" object } { "box" box } }\r
-{ $description "Stores a value into a box." }\r
-{ $errors "Throws an error if the box is full." } ;\r
-\r
-HELP: box>\r
-{ $values { "box" box } { "value" "the value of the box" } }\r
-{ $description "Removes a value from a box." }\r
-{ $errors "Throws an error if the box is empty." } ;\r
-\r
-HELP: ?box\r
-{ $values { "box" box } { "value/f" "the value of the box or " { $link f } } { "?" boolean } }\r
-{ $description "If the box is full, removes the value from the box and pushes " { $link t } ". If the box is empty pushes " { $snippet "f f" } "." } ;\r
-\r
-ARTICLE: "boxes" "Boxes"\r
-"A " { $emphasis "box" } " is a container which can either be empty or hold a single value."\r
-{ $subsections box }\r
-"Creating an empty box:"\r
-{ $subsections <box> }\r
-"Storing a value and removing a value from a box:"\r
-{ $subsections\r
-    >box\r
-    box>\r
-}\r
-"Safely removing a value:"\r
-{ $subsections ?box }\r
-"Testing if a box is full can be done by reading the " { $snippet "occupied" } " slot." ;\r
-\r
-ABOUT: "boxes"\r
+USING: help.markup help.syntax kernel ;
+IN: boxes
+
+HELP: box
+{ $class-description "A data type holding a single value in the " { $snippet "value" } " slot. The " { $snippet "occupied" } " slot indicates if the value is set." } ;
+
+HELP: <box>
+{ $values { "box" box } }
+{ $description "Creates a new empty box." } ;
+
+HELP: >box
+{ $values { "value" object } { "box" box } }
+{ $description "Stores a value into a box." }
+{ $errors "Throws an error if the box is full." } ;
+
+HELP: box>
+{ $values { "box" box } { "value" "the value of the box" } }
+{ $description "Removes a value from a box." }
+{ $errors "Throws an error if the box is empty." } ;
+
+HELP: ?box
+{ $values { "box" box } { "value/f" "the value of the box or " { $link f } } { "?" boolean } }
+{ $description "If the box is full, removes the value from the box and pushes " { $link t } ". If the box is empty pushes " { $snippet "f f" } "." } ;
+
+ARTICLE: "boxes" "Boxes"
+"A " { $emphasis "box" } " is a container which can either be empty or hold a single value."
+{ $subsections box }
+"Creating an empty box:"
+{ $subsections <box> }
+"Storing a value and removing a value from a box:"
+{ $subsections
+    >box
+    box>
+}
+"Safely removing a value:"
+{ $subsections ?box }
+"Testing if a box is full can be done by reading the " { $snippet "occupied" } " slot." ;
+
+ABOUT: "boxes"