[gnunet-scheme] 06/12: doc/bytevector-slices: Document the predicates.

[gnunet]

This is an automated email from the git hooks/post-receive script.

maxime-devos pushed a commit to branch master
in repository gnunet-scheme.

commit 75b8a7e07b6830d4cdb2d6fc94741c2bff366b9b
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Sun Sep 11 18:33:39 2022 +0200

    doc/bytevector-slices: Document the predicates.
    
    * doc/bytevector-slices.tm (Predicates): New section.
---
 doc/bytevector-slices.tm | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/doc/bytevector-slices.tm b/doc/bytevector-slices.tm
index 09f7936..a5d620c 100644
--- a/doc/bytevector-slices.tm
+++ b/doc/bytevector-slices.tm
@@ -92,6 +92,24 @@
     <scm|(make-slice/read-write <var|length>)><index|make-slice/read-write>
   </explain|Make a fresh, zero-initialised, read-write slice, of length
   <var|length>.>
+
+  <section|Predicates>
+
+  <\explain>
+    <scm|(slice? <var|object>)>
+  <|explain>
+    Return <scm|#true> if <var|object> is a slice, <scm|#false> otherwise.
+  </explain>
+
+  <\explain>
+    <scm|(slice-readable? <var|slice>)>
+  </explain|Return <scm|#true> if the slice <var|slice> is readable,
+  <scm|#false> otherwise.>
+
+  <\explain>
+    <scm|(slice-writable? <var|slice>)>
+  </explain|Return <scm|#true> if the slice <var|slice> is writable,
+  <scm|#false> otherwise.>
 </body>
 
 <\initial>

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.