[taler-docs] branch master updated (1eeb894 -> d0c163b)

[gnunet]

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

ttn pushed a change to branch master
in repository docs.

    from 1eeb894  mark up ‘TAX_RECORD_EXPIRATION’ (two instances)
     new cd87812  capitalize first word in sentence
     new 118f107  capitalize first word in sentence; add period at end of 
sentence
     new 13b909e  add period at end of sentence
     new c7af58b  capitalize first word in sentence; add period at end of 
sentence
     new a5f61c9  change markup of ‘never’ from " to ``
     new 280808a  add period at end of sentence (five instances)
     new 8dfed47  capitalize first word in sentence; add period at end of 
sentence (three instances)
     new a6c7bba  add period at end of sentence (three instances)
     new ea6c7e4  capitalize first word in sentence; add period at end of 
sentence (three instances)
     new 40c6f62  add period at end of sentence (two instances)
     new 4eb2872  add period at end of sentence
     new 93a0bde  fix typo: s/is is/is/
     new 7016fe6  add question mark at end of sentence
     new c80d5af  mark up ‘GNUNET_CRYPTO_random_timeflake()’
     new e01696f  fix typo: s/setup/set up/
     new 2bb49fd  add period at end of sentence
     new fa8bb1b  capitalize first word in sentence
     new b166ecf  capitalize first word in sentence (two instances)
     new 61ff15c  fix typo: s/card/cart/
     new 9f0d665  add period at end of sentence (two instances)
     new 83951fc  diction: s/towards the/portions of/
     new 61d9611  mark up ‘ContractTerms’
     new bef8ce7  add period at end of sentence (six instances)
     new 3d4bf5d  fix typo: s/requested_quanitity/requested_quantity/
     new 41865e6  s/milli-seconds/milliseconds/ (two instances)
     new fa7205f  mark up ‘delta’
     new 98cc61c  capitalize first word in sentence
     new 7507990  capitalize first word in sentence
     new d0c163b  capitalize first word in sentence; add period at end of 
sentence (six instances)

The 29 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-merchant.rst | 100 +++++++++++++++++++++++++-------------------------
 1 file changed, 50 insertions(+), 50 deletions(-)

diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 94ab7fd..ca4505f 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -1229,16 +1229,16 @@ Adding products to the inventory
 
     interface ProductAddDetail {
 
-      // product ID to use.
+      // Product ID to use.
       product_id: string;
 
       // Human-readable product description.
       description: string;
 
-      // Map from IETF BCP 47 language tags to localized descriptions
+      // Map from IETF BCP 47 language tags to localized descriptions.
       description_i18n: { [lang_tag: string]: string };
 
-      // unit in which the product is measured (liters, kilograms, packages, 
etc.)
+      // Unit in which the product is measured (liters, kilograms, packages, 
etc.).
       unit: string;
 
       // The price for one ``unit`` of the product. Zero is used
@@ -1248,10 +1248,10 @@ Adding products to the inventory
       // taxes.
       price: Amount;
 
-      // An optional base64-encoded product image
+      // An optional base64-encoded product image.
       image: ImageDataUrl;
 
-      // a list of taxes paid by the merchant for one unit of this product
+      // A list of taxes paid by the merchant for one unit of this product.
       taxes: Tax[];
 
       // Number of units of the product in stock in sum in total,
@@ -1279,7 +1279,7 @@ Adding products to the inventory
   request are optional, those that are not given are simply preserved (not
   modified).  Note that the ``description_i18n`` and ``taxes`` can only be
   modified in bulk: if it is given, all translations must be provided, not
-  only those that changed.  "never" should be used for the ``next_restock``
+  only those that changed.  ``never`` should be used for the ``next_restock``
   timestamp to indicate no intention/possibility of restocking, while a time
   of zero is used to indicate "unknown".
 
@@ -1300,10 +1300,10 @@ Adding products to the inventory
       // Human-readable product description.
       description: string;
 
-      // Map from IETF BCP 47 language tags to localized descriptions
+      // Map from IETF BCP 47 language tags to localized descriptions.
       description_i18n: { [lang_tag: string]: string };
 
-      // unit in which the product is measured (liters, kilograms, packages, 
etc.)
+      // Unit in which the product is measured (liters, kilograms, packages, 
etc.).
       unit: string;
 
       // The price for one ``unit`` of the product. Zero is used
@@ -1313,10 +1313,10 @@ Adding products to the inventory
       // taxes.
       price: Amount;
 
-      // An optional base64-encoded product image
+      // An optional base64-encoded product image.
       image: ImageDataUrl;
 
-      // a list of taxes paid by the merchant for one unit of this product
+      // A list of taxes paid by the merchant for one unit of this product.
       taxes: Tax[];
 
       // Number of units of the product in stock in sum in total,
@@ -1325,7 +1325,7 @@ Adding products to the inventory
       // A value of -1 indicates "infinite" (i.e. for "electronic" books).
       total_stock: Integer;
 
-      // Number of units of the product that were lost (spoiled, stolen, etc.)
+      // Number of units of the product that were lost (spoiled, stolen, etc.).
       total_lost: Integer;
 
       // Identifies where the product is in stock.
@@ -1352,7 +1352,7 @@ Inspecting inventory
   .. ts:def:: InventorySummaryResponse
 
     interface InventorySummaryResponse {
-      // List of products that are present in the inventory
+      // List of products that are present in the inventory.
       products: InventoryEntry[];
     }
 
@@ -1384,10 +1384,10 @@ Inspecting inventory
       // Human-readable product description.
       description: string;
 
-      // Map from IETF BCP 47 language tags to localized descriptions
+      // Map from IETF BCP 47 language tags to localized descriptions.
       description_i18n: { [lang_tag: string]: string };
 
-      // unit in which the product is measured (liters, kilograms, packages, 
etc.)
+      // Unit in which the product is measured (liters, kilograms, packages, 
etc.).
       unit: string;
 
       // The price for one ``unit`` of the product. Zero is used
@@ -1397,10 +1397,10 @@ Inspecting inventory
       // taxes.
       price: Amount;
 
-      // An optional base64-encoded product image
+      // An optional base64-encoded product image.
       image: ImageDataUrl;
 
-      // a list of taxes paid by the merchant for one unit of this product
+      // A list of taxes paid by the merchant for one unit of this product.
       taxes: Tax[];
 
       // Number of units of the product in stock in sum in total,
@@ -1412,7 +1412,7 @@ Inspecting inventory
       // Number of units of the product that have already been sold.
       total_sold: Integer;
 
-      // Number of units of the product that were lost (spoiled, stolen, etc.)
+      // Number of units of the product that were lost (spoiled, stolen, etc.).
       total_lost: Integer;
 
       // Identifies where the product is in stock.
@@ -1436,7 +1436,7 @@ Reserving inventory
   ``duration`` or ``quantity`` updates the existing lock for the same UUID
   and does not result in a conflict.
 
-  Unlocking by using a ``quantity`` of zero is is
+  Unlocking by using a ``quantity`` of zero is
   optional but recommended if customers remove products from the
   shopping cart. Note that actually POSTing to ``/orders`` with set
   ``manage_inventory`` and using ``lock_uuid`` will **transition** the
@@ -1467,7 +1467,7 @@ Reserving inventory
       // see https://github.com/anthonynsimon/timeflake
       lock_uuid: UUID;
 
-      // How long does the frontend intend to hold the lock
+      // How long does the frontend intend to hold the lock?
       duration: RelativeTime;
 
       // How many units should be locked?
@@ -1477,7 +1477,7 @@ Reserving inventory
 
   .. note::
 
-    The GNUNET_CRYPTO_random_timeflake() C API can be used
+    The ``GNUNET_CRYPTO_random_timeflake()`` C API can be used
     to generate such timeflakes for clients written in C.
 
 
@@ -1503,7 +1503,7 @@ Removing products from inventory
 Payment processing
 ------------------
 
-To process Taler payments, a merchant must first setup an order with
+To process Taler payments, a merchant must first set up an order with
 the merchant backend. The order is then claimed by a wallet, and
 paid by the wallet. The merchant can check the payment status of the
 order. Once the order is paid, the merchant may (for a limited time)
@@ -1554,19 +1554,19 @@ Creating orders
 
     interface PostOrderRequest {
       // The order must at least contain the minimal
-      // order detail, but can override all
+      // order detail, but can override all.
       order: Order;
 
-      // if set, the backend will then set the refund deadline to the current
+      // If set, the backend will then set the refund deadline to the current
       // time plus the specified delay.  If it's not set, refunds will not be
       // possible.
       refund_delay?: RelativeTime;
 
-      // specifies the payment target preferred by the client. Can be used
+      // Specifies the payment target preferred by the client. Can be used
       // to select among the various (active) wire methods supported by the 
instance.
       payment_target?: string;
 
-      // specifies that some products are to be included in the
+      // Specifies that some products are to be included in the
       // order from the inventory.  For these inventory management
       // is performed (so the products must be in stock) and
       // details are completed from the product data of the backend.
@@ -1576,7 +1576,7 @@ Creating orders
       // lock a product in the inventory.  Only useful if
       // ``manage_inventory`` is set.  Used in case a frontend
       // reserved quantities of the individual products while
-      // the shopping card was being built.  Multiple UUIDs can
+      // the shopping cart was being built.  Multiple UUIDs can
       // be used in case different UUIDs were used for different
       // products (i.e. in case the user started with multiple
       // shopping sessions that were combined during checkout).
@@ -1600,10 +1600,10 @@ Creating orders
   .. ts:def:: MinimalOrderDetail
 
     interface MinimalOrderDetail {
-      // Amount to be paid by the customer
+      // Amount to be paid by the customer.
       amount: Amount;
 
-      // Short summary of the order
+      // Short summary of the order.
       summary: string;
 
       // URL that will show that the order was successful after
@@ -1618,7 +1618,7 @@ Creating orders
   The following fields can be specified if the order is inventory-based.
   In this case, the backend can compute the amounts from the prices given
   in the inventory.  Note that if the frontend does give more details
-  (towards the ContractTerms), this will override those details
+  (portions of ``ContractTerms``), this will override those details
   (including total price) that would otherwise computed based on information
   from the inventory.
 
@@ -1634,10 +1634,10 @@ Creating orders
     that the backend would otherwise fill in via the inventory.
 
     interface MinimalInventoryProduct {
-      // Which product is requested (here mandatory!)
+      // Which product is requested (here mandatory!).
       product_id: string;
 
-      // How many units of the product are requested
+      // How many units of the product are requested.
       quantity: Integer;
     }
 
@@ -1645,7 +1645,7 @@ Creating orders
   .. ts:def:: PostOrderResponse
 
     interface PostOrderResponse {
-      // Order ID of the response that was just created
+      // Order ID of the response that was just created.
       order_id: string;
 
       // Token that authorizes the wallet to claim the order.
@@ -1659,13 +1659,13 @@ Creating orders
 
     interface OutOfStockResponse {
 
-      // Product ID of an out-of-stock item
+      // Product ID of an out-of-stock item.
       product_id: string;
 
-      // Requested quantity
+      // Requested quantity.
       requested_quantity: Integer;
 
-      // Available quantity (must be below ``requested_quanitity``)
+      // Available quantity (must be below ``requested_quantity``).
       available_quantity: Integer;
 
       // When do we expect the product to be again in stock?
@@ -1689,7 +1689,7 @@ Inspecting orders
   :query date: *Optional.* Time threshold, see ``delta`` for its 
interpretation.  Defaults to the oldest or most recent entry, depending on 
``delta``.
   :query start: *Optional*. Row number threshold, see ``delta`` for its 
interpretation.  Defaults to ``UINT64_MAX``, namely the biggest row id possible 
in the database.
   :query delta: *Optional*. takes value of the form ``N (-N)``, so that at 
most ``N`` values strictly older (younger) than ``start`` and ``date`` are 
returned.  Defaults to ``-20`` to return the last 20 entries (before ``start`` 
and/or ``date``).
-  :query timeout_ms: *Optional*. Timeout in milli-seconds to wait for 
additional orders if the answer would otherwise be negative (long polling). 
Only useful if delta is positive. Note that the merchant MAY still return a 
response that contains fewer than delta orders.
+  :query timeout_ms: *Optional*. Timeout in milliseconds to wait for 
additional orders if the answer would otherwise be negative (long polling). 
Only useful if delta is positive. Note that the merchant MAY still return a 
response that contains fewer than ``delta`` orders.
 
   **Response:**
 
@@ -1699,7 +1699,7 @@ Inspecting orders
   .. ts:def:: OrderHistory
 
     interface OrderHistory {
-      // timestamp-sorted array of all orders matching the query.
+      // Timestamp-sorted array of all orders matching the query.
       // The order of the sorting depends on the sign of ``delta``.
       orders : OrderHistoryEntry[];
     }
@@ -1709,28 +1709,28 @@ Inspecting orders
 
     interface OrderHistoryEntry {
 
-      // order ID of the transaction related to this entry.
+      // Order ID of the transaction related to this entry.
       order_id: string;
 
-      // row ID of the order in the database
+      // Row ID of the order in the database.
       row_id: number;
 
-      // when the order was created
+      // When the order was created.
       timestamp: Timestamp;
 
-      // the amount of money the order is for
+      // The amount of money the order is for.
       amount: Amount;
 
-      // the summary of the order
+      // The summary of the order.
       summary: string;
 
-      // whether some part of the order is refundable,
+      // Whether some part of the order is refundable,
       // that is the refund deadline has not yet expired
       // and the total amount refunded so far is below
       // the value of the original transaction.
       refundable: boolean;
 
-      // whether the order has been paid or not
+      // Whether the order has been paid or not.
       paid: boolean;
     }
 
@@ -1747,7 +1747,7 @@ Inspecting orders
 
   :query session_id: *Optional*. Session ID that the payment must be bound to. 
 If not specified, the payment is not session-bound.
   :query transfer: *Optional*. If set to "YES", try to obtain the wire 
transfer status for this order from the exchange. Otherwise, the wire transfer 
status MAY be returned if it is available.
-  :query timeout_ms: *Optional*. Timeout in milli-seconds to wait for a 
payment if the answer would otherwise be negative (long polling).
+  :query timeout_ms: *Optional*. Timeout in milliseconds to wait for a payment 
if the answer would otherwise be negative (long polling).
 
   **Response:**
 
@@ -2770,7 +2770,7 @@ The contract terms must have the following structure:
     // Human-readable description of the whole purchase
     summary: string;
 
-    // Map from IETF BCP 47 language tags to localized summaries
+    // Map from IETF BCP 47 language tags to localized summaries.
     summary_i18n?: { [lang_tag: string]: string };
 
     // Unique, free-form identifier for the proposal.
@@ -2906,22 +2906,22 @@ The `Product` object describes the product being 
purchased from the merchant. It
     // Human-readable product description.
     description: string;
 
-    // Map from IETF BCP 47 language tags to localized descriptions
+    // Map from IETF BCP 47 language tags to localized descriptions.
     description_i18n?: { [lang_tag: string]: string };
 
     // The number of units of the product to deliver to the customer.
     quantity?: Integer;
 
-    // The unit in which the product is measured (liters, kilograms, packages, 
etc.)
+    // Unit in which the product is measured (liters, kilograms, packages, 
etc.).
     unit?: string;
 
     // The price of the product; this is the total price for ``quantity`` 
times ``unit`` of this product.
     price?: Amount;
 
-    // An optional base64-encoded product image
+    // An optional base64-encoded product image.
     image?: ImageDataUrl;
 
-    // a list of taxes paid by the merchant for this product. Can be empty.
+    // A list of taxes paid by the merchant for this product. Can be empty.
     taxes?: Tax[];
 
     // time indicating when this product should be delivered

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