]> gitweb.factorcode.org Git - factor.git/commitdiff
specialized-vectors: improved documentation
authorSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Wed, 23 Sep 2009 08:08:54 +0000 (03:08 -0500)
committerSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Wed, 23 Sep 2009 08:08:54 +0000 (03:08 -0500)
basis/specialized-vectors/specialized-vectors-docs.factor

index 9c575fe73a0b8a01d5b0df024275294bc72db9a2..c773356a64bdaecc8cf7c775bc64de109cdca81d 100644 (file)
@@ -16,8 +16,8 @@ ARTICLE: "specialized-vector-words" "Specialized vector words"
 }
 "Behind the scenes, these words are placed in a vocabulary named " { $snippet "specialized-vectors.instances.T" } ", however this vocabulary should not be placed in a " { $link POSTPONE: USING: } " form directly. Instead, always use " { $link POSTPONE: SPECIALIZED-VECTOR: } ". This ensures that the vocabulary can get generated the first time it is needed." ;
 
-ARTICLE: "specialized-vector-c" "Passing specialized arrays to C functions"
-"Each specialized array has a " { $slot "underlying" } " slot holding a specialized array, which in turn has an " { $slot "underlying" } " slot holding a " { $link byte-array } " with the raw data. Passing a specialized vector as a parameter to a C function call will automatically extract the underlying data. To get at the underlying data directly, call the " { $link >c-ptr } " word on a specialized vector." ;
+ARTICLE: "specialized-vector-c" "Passing specialized vectors to C functions"
+"Each specialized vector has a " { $slot "underlying" } " slot holding a specialized array, which in turn has an " { $slot "underlying" } " slot holding a " { $link byte-array } " with the raw data. Passing a specialized vector as a parameter to a C function call will automatically extract the underlying data. To get at the underlying data directly, call the " { $link >c-ptr } " word on a specialized vector." ;
 
 ARTICLE: "specialized-vectors" "Specialized vectors"
 "The " { $vocab-link "specialized-vectors" } " vocabulary implements resizable sequence types for storing machine values in a space-efficient manner without boxing."