[taler-docs] branch master updated (93162c1 -> 4888588)

[gnunet]

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

ttn pushed a change to branch master
in repository docs.

    from 93162c1  add article "the"
     new a7bd45a  delete spurious eol ws
     new 7f7a1fe  add FIXME
     new c7962b5  add period at end of sentence (six instances)
     new 4df7ac5  add period at end of sentence (three instances)
     new ad49f0f  remove spurious space
     new 4f11c11  fix typo: s/forever/never/
     new 67c93dc  add period at end of sentence (three instances)
     new 6c7ac21  add period at end of sentence
     new 4b5e018  add period at end of sentence (four instances)
     new 17701bc  add period at end of sentence
     new aef61d4  fix typo: s/is a//
     new 45e44d8  add period at end of sentence
     new 35a2d2b  fix typo: s/constrains/constraints/
     new c790492  remove spurious comment "* asd"
     new 154ce3f  add period at end of sentence
     new c560d58  add period at end of sentence
     new 4888588  fix typo: s/structure/structures/

The 17 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 core/api-common.rst | 57 ++++++++++++++++++++++++++---------------------------
 1 file changed, 28 insertions(+), 29 deletions(-)

diff --git a/core/api-common.rst b/core/api-common.rst
index 5171a2c..99761f6 100644
--- a/core/api-common.rst
+++ b/core/api-common.rst
@@ -43,7 +43,7 @@ handle the error as if an internal error (500) had been 
returned.
   **Response:**
 
   :resheader Content-Type: application/json
-                           
+
   :http:statuscode:`200 Ok`:
     The request was successful.
   :http:statuscode:`301 Moved permanently`:
@@ -76,7 +76,7 @@ handle the error as if an internal error (500) had been 
returned.
     server errors are always reported to the exchange operator, a good operator
     should naturally be able to address them in a timely fashion, especially
     within 24h.  When generating an internal server error, the exchange 
responds with
-    a JSON object containing the following fields:
+    a JSON object containing the following fields: FIXME: What are the fields?
   :http:statuscode:`400 Bad request`:
     One of the arguments to the request is missing or malformed.
 
@@ -100,22 +100,22 @@ handle the error as if an internal error (500) had been 
returned.
       // Optional detail about the specific input value that failed. May 
change without notice!
       detail?: string;
 
-      // Name of the parameter that was bogus (if applicable)
+      // Name of the parameter that was bogus (if applicable).
       parameter?: string;
 
-      // Path to the argument that was bogus (if applicable)
+      // Path to the argument that was bogus (if applicable).
       path?: string;
 
-      // Offset of the argument that was bogus (if applicable)
+      // Offset of the argument that was bogus (if applicable).
       offset?: string;
 
-      // Index of the argument that was bogus (if applicable)
+      // Index of the argument that was bogus (if applicable).
       index?: string;
 
-      // Name of the object that was bogus (if applicable)
+      // Name of the object that was bogus (if applicable).
       object?: string;
 
-      // Name of the currency than was problematic (if applicable)
+      // Name of the currency than was problematic (if applicable).
       currency?: string;
 
       // Expected type (if applicable).
@@ -212,12 +212,12 @@ hashed data. See `base32`_.
 
 .. ts:def:: HashCode
 
-  // 64-byte hash code
+  // 64-byte hash code.
   type HashCode = string;
 
 .. ts:def:: ShortHashCode
 
-  // 32-byte hash code
+  // 32-byte hash code.
   type ShortHashCode = string;
 
 
@@ -230,13 +230,13 @@ the range that is safely representable in JavaScript.
 .. ts:def:: SafeUint64
 
   // Subset of numbers:  Integers in the
-  // inclusive range 0 .. (2^53 - 1)
+  // inclusive range 0 .. (2^53 - 1).
   type SafeUint64 = number;
 
 Large numbers
 ^^^^^^^^^^^^^
 
-Large numbers such as RSA blinding factors and 256 bit  keys, are transmitted
+Large numbers such as RSA blinding factors and 256 bit keys, are transmitted
 as other binary data in Crockford Base32 encoding.
 
 Timestamps
@@ -248,7 +248,7 @@ Timestamps are represented by the following structure:
 
   interface Timestamp {
     // Milliseconds since epoch, or the special
-    // value "forever" to represent an event that will
+    // value "never" to represent an event that will
     // never happen.
     t_ms: number | "never";
   }
@@ -270,7 +270,7 @@ Integers
 
 .. ts:def:: Integer
 
-  // JavaScript numbers restricted to integers
+  // JavaScript numbers restricted to integers.
   type Integer = number;
 
 Objects
@@ -278,7 +278,7 @@ Objects
 
 .. ts:def:: Object
 
-  // JavaScript objects, no further restrictions
+  // JavaScript objects, no further restrictions.
   type Object = object;
 
 Keys
@@ -286,7 +286,7 @@ Keys
 
 .. ts:def:: ClaimToken
 
-  // 16-byte access token used to authorize access
+  // 16-byte access token used to authorize access.
   type ClaimToken = string;
 
 .. ts:def:: EddsaPublicKey
@@ -333,7 +333,7 @@ Blinded coin
 
 .. ts:def:: CoinEnvelope
 
-  // Blinded coin's `public EdDSA key <eddsa-coin-pub>`, `base32` encoded
+  // Blinded coin's `public EdDSA key <eddsa-coin-pub>`, `base32` encoded.
   type CoinEnvelope = string;
 
 .. ts:def:: DenominationBlindingKeyP
@@ -344,7 +344,7 @@ Blinded coin
    type DenominationBlindingKeyP = string;
 
 
-  
+
 .. _signature:
 
 Signatures
@@ -354,22 +354,22 @@ Signatures
 .. ts:def:: EddsaSignature
 
   // EdDSA signatures are transmitted as 64-bytes `base32`
-  // binary-encoded objects with just the R and S values (base32_ binary-only)
+  // binary-encoded objects with just the R and S values (base32_ binary-only).
   type EddsaSignature = string;
 
 .. ts:def:: RsaSignature
 
-  // `base32` encoded RSA signature
+  // `base32` encoded RSA signature.
   type RsaSignature = string;
 
 .. ts:def:: BlindedRsaSignature
 
-  // `base32` encoded RSA blinded signature
+  // `base32` encoded RSA blinded signature.
   type BlindedRsaSignature = string;
 
 .. ts:def:: RsaBlindingKeySecret
 
-  // `base32` encoded RSA blinding secret
+  // `base32` encoded RSA blinding secret.
   type RsaBlindingKeySecret = string;
 
 .. _amount:
@@ -388,14 +388,14 @@ this allows accurate representation of monetary amounts.
 The following constrains apply for a valid amount:
 
 1. The ``<Currency>`` part must be at most 12 characters long and may not 
contain a colon (``:``).
-2. The integer part of ``<DecimalAmount>`` may be at most 2^52
+2. The integer part of ``<DecimalAmount>`` may be at most 2^52.
 3. the fractional part of ``<DecimalAmount>`` may contain at most 8 decimal 
digits.
 
 Internally, amounts are parsed into the following object:
 
 .. note::
 
-  "EUR:1.50" and "EUR:10" are is a valid amounts.  These are all invalid 
amounts: "A:B:1.5", "EUR:4503599627370501.0", "EUR:1.", "EUR:.1"
+  "EUR:1.50" and "EUR:10" are valid amounts.  These are all invalid amounts: 
"A:B:1.5", "EUR:4503599627370501.0", "EUR:1.", "EUR:.1".
 
 .. ts:def:: ParsedAmount
 
@@ -644,25 +644,24 @@ Any piece of signed data, complies to the abstract data 
structure given below.
   struct GNUNET_CRYPTO_EccSignaturePurpose {
     /**
 
-    The following constrains apply for a valid amount:
+    The following constraints apply for a valid amount:
 
-    * asd
      * This field is used to express the context in
      * which the signature is made, ensuring that a
      * signature cannot be lifted from one part of the protocol
      * to another. See `src/include/taler_signatures.h` within the
-     * exchange's codebase (git://taler.net/exchange)
+     * exchange's codebase (git://taler.net/exchange).
      */
     uint32_t purpose;
     /**
      * This field equals the number of bytes being signed,
-     * namely 'sizeof (struct Data)'
+     * namely 'sizeof (struct Data)'.
      */
     uint32_t size;
   };
 
 
-The following list contains all the data structure that can be signed in
+The following list contains all the data structures that can be signed in
 Taler. Their definition is typically found in 
``src/include/taler_signatures.h``,
 within the
 `exchange's codebase 
<https://docs.taler.net/global-licensing.html#exchange-repo>`_.

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