[gnunet-scheme] 09/12: doc/bytevector-slices: Document slice-X-ref and slice-X-set! more.

[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 6617149009dcf4c3797830d606b2e4d7ba10ccea
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Mon Sep 12 18:34:27 2022 +0200

    doc/bytevector-slices: Document slice-X-ref and slice-X-set! more.
    
    * doc/bytevector-slice.tm (Reading / modifying bytevector slices):
    Document error conditions.
---
 doc/bytevector-slices.tm | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/bytevector-slices.tm b/doc/bytevector-slices.tm
index ff27d0a..e12f4ff 100644
--- a/doc/bytevector-slices.tm
+++ b/doc/bytevector-slices.tm
@@ -159,6 +159,11 @@
   <scm|slice-s8-ref> and <scm|slice-s8-set!> do not have an endianness
   argument. Aside from that, they behave similarly to the other
   <scm|slice-X-ref> and <scm|slice-X-set!> procedures.
+
+  <scm|slice-X-ref> requires the slice to be readable, if not, an appropriate
+  <scm|&missing-capabilities> exception is raised. Likewise,
+  <scm|slice-X-set!> requires the slice to be writable. Both require the part
+  of the slice that is being read to be in-bounds.
 </body>
 
 <\initial>

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