]> gitweb.factorcode.org Git - factor.git/commitdiff
io.sockets.secure.openssl: cleanup docs.
authorJohn Benediktsson <mrjbq7@gmail.com>
Fri, 17 Dec 2021 17:17:20 +0000 (09:17 -0800)
committerJohn Benediktsson <mrjbq7@gmail.com>
Sat, 18 Dec 2021 23:06:31 +0000 (15:06 -0800)
basis/io/sockets/secure/openssl/openssl-docs.factor
basis/io/sockets/secure/openssl/openssl.factor

index c8fe87f93b167881d909d98c791c7b1505011c16..8353cda5598ab95ab13d57b6dc05289ffe16a090 100644 (file)
@@ -28,22 +28,22 @@ HELP: do-ssl-read
 { $values
   { "buffer" buffer }
   { "ssl" SSL }
-  { "event/f" "f or a symbol indicating the desired operation" } }
+  { "event/f" { $maybe "a symbol indicating the desired operation" } } }
 { $description "Reads from the ssl connection to the buffer." } ;
 
 HELP: do-ssl-write
 { $values
   { "buffer" buffer }
   { "ssl" SSL }
-  { "event/f" "f or a symbol indicating the desired operation" } }
+  { "event/f" { $maybe "a symbol indicating the desired operation" } } }
 { $description "Writes from the buffer to the ssl connection." } ;
 
 HELP: check-ssl-error
 { $values
   { "ssl" SSL }
   { "ret" "error code returned by an SSL function" }
-  { "exra-cases/f" "f or an assoc of error codes and quotations" }
-  { "event/f" "f or a symbol indicating the desired operation" }
+  { "extra-cases/f" { $maybe "an assoc of error codes and quotations" } }
+  { "event/f" { $maybe "a symbol indicating the desired operation" } }
 }
 { $description "Checks if the last SSL function returned successfully or not. If so, returns " { $link f } " or a symbol, " { $link +input+ } " or " { $link +output+ } ", that indicates the socket operation required by libssl." } ;
 
index 3fb382e4bda86d9ce9f4e9a5e500c7aeacf1d5e2..ae6180ac5b1503d13be0c31a36d37e327065d634 100644 (file)
@@ -291,7 +291,7 @@ PRIVATE>
         } case
     ] [ nip (ssl-error) ] if-zero ;
 
-: check-ssl-error ( ssl ret exra-cases/f -- event/f )
+: check-ssl-error ( ssl ret extra-cases/f -- event/f )
     [ tuck SSL_get_error ] dip
     {
         { SSL_ERROR_NONE [ drop f ] }