Updating sequence and hashtable documentation to point more clearly at the relevant...

[factor.git] / core / vectors / vectors-docs.factor

diff --git a/core/vectors/vectors-docs.factor b/core/vectors/vectors-docs.factor
index 2af130049856d3011067d57dd64c4d841eff2926..fe40a27182b9d1649f0f29aee98ecfc44cc93350 100644 (file)
--- a/core/vectors/vectors-docs.factor
+++ b/core/vectors/vectors-docs.factor
@@ -4,17 +4,23 @@ vectors.private combinators ;
 IN: vectors
 
 ARTICLE: "vectors" "Vectors"
-"A vector is a resizable mutable sequence of objects. The literal syntax is covered in " { $link "syntax-vectors" } ". Vector words are found in the " { $vocab-link "vectors" } " vocabulary."
+"The " { $vocab-link "vectors" } " vocabulary implements resizable mutable sequence which support the " { $link "sequence-protocol" } "."
 $nl
-"Vectors form a class:"
+"The " { $vocab-link "vectors" } " vocabulary only includes words for creating new vectors. To access and modify vector elements, use " { $link "sequences" } " in the " { $vocab-link "sequences" } " vocabulary."
+$nl
+"Vector literal syntax is documented in " { $link "syntax-vectors" } "."
+$nl
+"Vectors are intended to be used with " { $link "sequences-destructive" } ". Code that does not modify sequences in-place can use fixed-size arrays without loss of generality; see " { $link "arrays" } "."
+$nl
+"Vectors form a class of objects:"
 { $subsection vector }
 { $subsection vector? }
-"Creating vectors:"
+"Creating new vectors:"
 { $subsection >vector }
 { $subsection <vector> }
 "Creating a vector from a single element:"
 { $subsection 1vector }
-"If you don't care about initial capacity, a more elegant way to create a new vector is to write:"
+"If you don't care about initial capacity, an elegant way to create a new vector is to write:"
 { $code "V{ } clone" } ;
 
 ABOUT: "vectors"