Documentation updates

diff --git a/core/checksums/checksums-docs.factor b/core/checksums/checksums-docs.factor
index 9196008ba630466bb88de2ac645142da57d02419..6ef0e850253a8b7b830700afdf05821fc484ac0d 100644 (file)
--- a/core/checksums/checksums-docs.factor
+++ b/core/checksums/checksums-docs.factor
@@ -49,4 +49,7 @@ $nl
 { $vocab-subsection "MD5 checksum" "checksums.md5" }
 { $vocab-subsection "SHA1 checksum" "checksums.sha1" }
 { $vocab-subsection "SHA2 checksum" "checksums.sha2" }
-{ $vocab-subsection "Adler-32 checksum" "checksums.adler-32" } ;
+{ $vocab-subsection "Adler-32 checksum" "checksums.adler-32" }
+{ $vocab-subsection "OpenSSL checksums" "checksums.openssl" } ;
+
+ABOUT: "checksums"

diff --git a/core/kernel/kernel-docs.factor b/core/kernel/kernel-docs.factor
index 0ef8919713eafc3117ee9c5f2058dffec7907b0e..d1422555357f47365f02d0b43c8d0167d596e032 100755 (executable)
--- a/core/kernel/kernel-docs.factor
+++ b/core/kernel/kernel-docs.factor
@@ -148,7 +148,7 @@ $nl
 { $subsection "spread-shuffle-equivalence" } ;
 
 ARTICLE: "apply-combinators" "Apply combinators"
-"The apply combinators apply multiple quotations to multiple values. The " { $snippet "@" } " suffix signifies application."
+"The apply combinators apply a single quotation to multiple values. The " { $snippet "@" } " suffix signifies application."
 $nl
 "Two quotations:"
 { $subsection bi@ }
@@ -179,6 +179,7 @@ ARTICLE: "compositional-combinators" "Compositional combinators"
 { $subsection with }
 { $subsection compose }
 { $subsection 3compose }
+{ $subsection prepose }
 "Quotations also implement the sequence protocol, and can be manipulated with sequence words; see " { $link "quotations" } "." ;
 
 ARTICLE: "implementing-combinators" "Implementing combinators"
@@ -835,8 +836,16 @@ HELP: compose ( quot1 quot2 -- compose )
     "However, " { $link compose } " runs in constant time, and the optimizing compiler is able to compile code which calls composed quotations."
 } ;
 
+
+HELP: prepose
+{ $values { "quot1" callable } { "quot2" callable } { "compose" compose } }
+{ $description "Quotation composition. Outputs a " { $link callable } " which calls " { $snippet "quot2" } " followed by " { $snippet "quot1" } "." }
+{ $notes "See " { $link compose } " for details." } ;
+
+{ compose prepose } related-words
+
 HELP: 3compose
-{ $values { "quot1" callable } { "quot2" callable } { "quot3" callable } { "curry" curry } }
+{ $values { "quot1" callable } { "quot2" callable } { "quot3" callable } { "compose" compose } }
 { $description "Quotation composition. Outputs a " { $link callable } " which calls " { $snippet "quot1" } ", " { $snippet "quot2" } " and then " { $snippet "quot3" } "." }
 { $notes
     "The three quotations must leave the retain stack in the same state on exit as it was on entry, so for example, the following code is not allowed:"

diff --git a/core/kernel/kernel.factor b/core/kernel/kernel.factor
index a72e25b9e0ca215e8492c8a27dd69c95fe7128a9..a989d6c833f3e19a88666db61ad8d42196accb3e 100755 (executable)
--- a/core/kernel/kernel.factor
+++ b/core/kernel/kernel.factor
@@ -156,10 +156,10 @@ M: callstack clone (clone) ;
 : with ( param obj quot -- obj curry )
     swapd [ swapd call ] 2curry ; inline
 
-: prepose ( quot1 quot2 -- curry )
+: prepose ( quot1 quot2 -- compose )
     swap compose ; inline
 
-: 3compose ( quot1 quot2 quot3 -- curry )
+: 3compose ( quot1 quot2 quot3 -- compose )
     compose compose ; inline
 
 ! Booleans

diff --git a/extra/checksums/adler-32/adler-32-docs.factor b/extra/checksums/adler-32/adler-32-docs.factor
index b7400cbaa09c00ebe036266bcd12d1bd09bd0451..3e4e5d8210286d2502f4f67e6d87693622211aaf 100755 (executable)
--- a/extra/checksums/adler-32/adler-32-docs.factor
+++ b/extra/checksums/adler-32/adler-32-docs.factor
@@ -2,7 +2,7 @@ USING: help.markup help.syntax ;
 IN: checksums.adler-32
 
 HELP: adler-32
-{ $description "Adler-32 checksum algorithm." } ;
+{ $class-description "Adler-32 checksum algorithm." } ;
 
 ARTICLE: "checksums.adler-32" "Adler-32 checksum"
 "The Adler-32 checksum algorithm implements simple and fast checksum. It is used in zlib and rsync."

diff --git a/extra/checksums/md5/md5-docs.factor b/extra/checksums/md5/md5-docs.factor
index dca039d1d3dab827869763550c56ae73c03b679a..4e475b18a0b557858c4f5f626b6ab77d8ef95f54 100755 (executable)
--- a/extra/checksums/md5/md5-docs.factor
+++ b/extra/checksums/md5/md5-docs.factor
@@ -2,7 +2,7 @@ USING: help.markup help.syntax ;
 IN: checksums.md5
 
 HELP: md5
-{ $description "MD5 checksum algorithm." } ;
+{ $class-description "MD5 checksum algorithm." } ;
 
 ARTICLE: "checksums.md5" "MD5 checksum"
 "The MD5 checksum algorithm implements a one-way hash function. While it is widely used, many weaknesses are known and it should not be used in new applications (" { $url "http://www.schneier.com/blog/archives/2005/03/more_hash_funct.html" } ")."

diff --git a/extra/checksums/sha1/sha1-docs.factor b/extra/checksums/sha1/sha1-docs.factor
index 8b8bf1cfa9615ca7104fa2a16d21dd9d71497ea7..2c9093865fc2adeb68c709c7a1e21a96fdeec677 100644 (file)
--- a/extra/checksums/sha1/sha1-docs.factor
+++ b/extra/checksums/sha1/sha1-docs.factor
@@ -2,7 +2,7 @@ USING: help.markup help.syntax ;
 IN: checksums.sha1
 
 HELP: sha1
-{ $description "SHA1 checksum algorithm." } ;
+{ $class-description "SHA1 checksum algorithm." } ;
 
 ARTICLE: "checksums.sha1" "SHA1 checksum"
 "The SHA1 checksum algorithm implements a one-way hash function. It is generally considered to be stronger than MD5, however there is a known algorithm for finding collisions more effectively than a brute-force search (" { $url "http://www.schneier.com/blog/archives/2005/02/sha1_broken.html" } ")."

diff --git a/extra/checksums/sha2/sha2-docs.factor b/extra/checksums/sha2/sha2-docs.factor
index c39831b266d43f4e7d0f8688cdf85f395da2bb61..6a128552fdc14ee1ae44cfb4b2eab6a0586b0c37 100644 (file)
--- a/extra/checksums/sha2/sha2-docs.factor
+++ b/extra/checksums/sha2/sha2-docs.factor
@@ -2,7 +2,7 @@ USING: help.markup help.syntax ;
 IN: checksums.sha2
 
 HELP: sha-256
-{ $description "SHA-256 checksum algorithm." } ;
+{ $class-description "SHA-256 checksum algorithm." } ;
 
 ARTICLE: "checksums.sha2" "SHA2 checksum"
 "The SHA2 checksum algorithm implements a one-way hash function. It is generally considered to be pretty strong."