[gnunet-scheme] 01/03: doc: Correct/improve language in DHT documentation.

[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 cdf59a76625400801f61d8cfef28e59144a7d6d2
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Sun Dec 26 11:24:13 2021 +0000

    doc: Correct/improve language in DHT documentation.
    
    * doc/scheme-gnunet.tm (make-datum,datum->insertion,make-query): Fix
      typos and make the grammar a little nicer.
---
 doc/scheme-gnunet.tm | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/doc/scheme-gnunet.tm b/doc/scheme-gnunet.tm
index b6316cc..4900b7f 100644
--- a/doc/scheme-gnunet.tm
+++ b/doc/scheme-gnunet.tm
@@ -1080,28 +1080,28 @@
   <|explain>
     Make a datum object of block type <var|type> (or its corresponding
     numeric value), with key <var|key> (a readable <scm|/hashcode:512>
-    bytevector slice), value <var|value> (a readable bytevector slice)
+    bytevector slice), value <var|value> (a readable bytevector slice) and
     expiring at <var|expiration> (<todo|type, epoch>). The keyword argument
     <var|expiration> is optional, see <reference|???>.
 
-    The type can be retrieved with the accessor <scm|datum-type>, returning
-    the numeric value of the block type. The accessors <scm|datum-key>,
-    <scm|datum-value> and <scm|datum-expiration> return the key, value and
-    expiration time respectively. It can be tested if an object is a datum
-    object with the predicate <scm|datum?>.
+    The numeric value of the block type can be retrieved with the accessor
+    <scm|datum-type>. The accessors <scm|datum-key>, <scm|datum-value> and
+    <scm|datum-expiration> return the key, value and expiration time
+    respectively. It can be tested if an object is a datum object with the
+    predicate <scm|datum?>.
   </explain>
 
   <\explain>
     <scm|(datum-\<gtr\>insertion <var|datum> #:desired-replication-level)>
   <|explain>
     Make an insertion object for inserting the datum <var|datum>, desiring a
-    certain replication level <var|desired-replication-level>. This keyword
-    argument is optional, see <reference|???>. <todo|various options>.
+    replication level <var|desired-replication-level> (see
+    <reference|replication levels???>)<todo|various options>.
 
     The datum and desired replication level can be recovered with the
     accessors <scm|insertion-\<gtr\>datum> and
-    <var|desired-replication-level>. It can be tested if an object is a datum
-    object with the predicate <scm|insertion?>.
+    <var|insertion-desired-replication-level>. It can be tested if an object
+    is an insertion object with the predicate <scm|insertion?>.
   </explain>
 
   <\explain>
@@ -1110,13 +1110,13 @@
     Make a query object for searching for a value of block type <var|type>
     (or its corresponding numeric value), with key <var|key> (a readable
     <scm|/hashcode:512> bytevector slice), at desired replication level
-    <scm|desired-replication-level>. This keyword argument is optional, see
-    <reference|???>. <todo|various options, xquery>
+    <scm|desired-replication-level> (see <reference|replication levels???>).
+    <todo|various options, xquery>
 
-    The type (as a numeric value), the key and the desired replication level
-    can be recovered with the accessors <scm|query-type>, <scm|query-key> and
-    <scm|query-desired-replication-level>. It can be tested if an object is a
-    query object with the predicate <scm|query?>.
+    The numeric value of the block type, the key and the desired replication
+    level can be recovered with the accessors <scm|query-type>,
+    <scm|query-key> and <scm|query-desired-replication-level>. It can be
+    tested if an object is a query object with the predicate <scm|query?>.
   </explain>
 
   <\explain>

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