more docs
							parent
							
								
									e22a7a6100
								
							
						
					
					
						commit
						1e538ccd03
					
				| 
						 | 
					@ -341,6 +341,9 @@ HELP: set-callstack ( cs -- )
 | 
				
			||||||
HELP: clear
 | 
					HELP: clear
 | 
				
			||||||
{ $description "Clears the data stack." } ;
 | 
					{ $description "Clears the data stack." } ;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					HELP: build
 | 
				
			||||||
 | 
					{ $description "The current build number. Factor increments this number whenever a new boot image is created." } ;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
HELP: hashcode*
 | 
					HELP: hashcode*
 | 
				
			||||||
{ $values { "depth" integer } { "obj" object } { "code" fixnum } }
 | 
					{ $values { "depth" integer } { "obj" object } { "code" fixnum } }
 | 
				
			||||||
{ $contract "Outputs the hashcode of an object. The hashcode operation must satisfy the following properties:"
 | 
					{ $contract "Outputs the hashcode of an object. The hashcode operation must satisfy the following properties:"
 | 
				
			||||||
| 
						 | 
					@ -393,7 +396,7 @@ HELP: identity-tuple
 | 
				
			||||||
HELP: <=>
 | 
					HELP: <=>
 | 
				
			||||||
{ $values { "obj1" object } { "obj2" object } { "n" real } }
 | 
					{ $values { "obj1" object } { "obj2" object } { "n" real } }
 | 
				
			||||||
{ $contract
 | 
					{ $contract
 | 
				
			||||||
    "Compares two objects using an intrinsic partial order, for example, the natural order for real numbers and lexicographic order for strings."
 | 
					    "Compares two objects using an intrinsic total order, for example, the natural order for real numbers and lexicographic order for strings."
 | 
				
			||||||
    $nl
 | 
					    $nl
 | 
				
			||||||
    "The output value is one of the following:"
 | 
					    "The output value is one of the following:"
 | 
				
			||||||
    { $list
 | 
					    { $list
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -83,6 +83,29 @@ HELP: >=
 | 
				
			||||||
{ $values { "x" real } { "y" real } { "?" "a boolean" } }
 | 
					{ $values { "x" real } { "y" real } { "?" "a boolean" } }
 | 
				
			||||||
{ $description "Tests if " { $snippet "x" } " is greater than or equal to " { $snippet "y" } "." } ;
 | 
					{ $description "Tests if " { $snippet "x" } " is greater than or equal to " { $snippet "y" } "." } ;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					HELP: before?
 | 
				
			||||||
 | 
					{ $values { "obj1" "an object" } { "obj2" "an object" } { "?" "a boolean" } }
 | 
				
			||||||
 | 
					{ $description "Tests if " { $snippet "obj1" } " comes before " { $snippet "obj2" } " using an intrinsic total order." }
 | 
				
			||||||
 | 
					{ $notes "Implemented using " { $link <=> } "." } ;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					HELP: after?
 | 
				
			||||||
 | 
					{ $values { "obj1" "an object" } { "obj2" "an object" } { "?" "a boolean" } }
 | 
				
			||||||
 | 
					{ $description "Tests if " { $snippet "obj1" } " comes after " { $snippet "obj2" } " using an intrinsic total order." }
 | 
				
			||||||
 | 
					{ $notes "Implemented using " { $link <=> } "." } ;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					HELP: before=?
 | 
				
			||||||
 | 
					{ $values { "obj1" "an object" } { "obj2" "an object" } { "?" "a boolean" } }
 | 
				
			||||||
 | 
					{ $description "Tests if " { $snippet "obj1" } " comes before or equals " { $snippet "obj2" } " using an intrinsic total order." }
 | 
				
			||||||
 | 
					{ $notes "Implemented using " { $link <=> } "." } ;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					HELP: after=?
 | 
				
			||||||
 | 
					{ $values { "obj1" "an object" } { "obj2" "an object" } { "?" "a boolean" } }
 | 
				
			||||||
 | 
					{ $description "Tests if " { $snippet "obj1" } " comes after or equals " { $snippet "obj2" } " using an intrinsic total order." }
 | 
				
			||||||
 | 
					{ $notes "Implemented using " { $link <=> } "." } ;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					{ before? after? before=? after=? } related-words
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
HELP: +
 | 
					HELP: +
 | 
				
			||||||
{ $values { "x" number } { "y" number } { "z" number } }
 | 
					{ $values { "x" number } { "y" number } { "z" number } }
 | 
				
			||||||
{ $description
 | 
					{ $description
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue