[taler-docs] branch master updated: language / formatting

[gnunet]

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

dold pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new 1a34d06  language / formatting
1a34d06 is described below

commit 1a34d067d2b6c4d96ffb438ecc7ca3cd78913d91
Author: Florian Dold <florian@dold.me>
AuthorDate: Sun Jan 24 16:10:57 2021 +0100

    language / formatting
---
 libeufin/nexus-tutorial.rst | 70 +++++++++++++++++----------------------------
 1 file changed, 27 insertions(+), 43 deletions(-)

diff --git a/libeufin/nexus-tutorial.rst b/libeufin/nexus-tutorial.rst
index 1e3deb9..c00b9d4 100644
--- a/libeufin/nexus-tutorial.rst
+++ b/libeufin/nexus-tutorial.rst
@@ -317,10 +317,10 @@ step is needed to let the user pick a custom name for 
such accounts.
       connections \
         import-bank-account \
           --offered-account-id testacct01 \
-          --nexus-bank-account-id $CUSTOM_RENAMING_FOR_ACCOUNT \
+          --nexus-bank-account-id $LOCAL_ACCOUNT_NAME \
           $CONNECTION_NAME
 
-Once a Nexus user imported a bank account (``$CUSTOM_RENAMING_FOR_ACCOUNT``)
+Once a Nexus user imported a bank account (``$LOCAL_ACCOUNT_NAME``)
 under a certain connection (``$CONNECTION_NAME``), it is possible
 to accomplish the usual operations for any bank account: asking for the
 list of transactions, and making a payment.
@@ -328,22 +328,16 @@ list of transactions, and making a payment.
 Request history of transactions
 ===============================
 
-..
+The LibEuFin nexus keeps a local copy of the bank account's transaction
+history.  Before querying transactions locally, it is necessary
+to request transactions for the bank account via the bank connection.
 
-  FIXME: explain why requesting the history
-  goes through these two-phases.
-
-It is first needed to tell Nexus to download the latest news
-from the bank, and then ask it again to return the results.
-
-This command asks Nexus to *download the latest bank statements*:
+This command asks Nexus to download the latest transaction reports/statements
+through the bank connection:
 
 .. code-block:: console
 
-  $ libeufin-cli \
-      accounts \
-        fetch-transactions \
-          $CUSTOM_RENAMING_FOR_ACCOUNT
+  $ libeufin-cli accounts fetch-transactions $LOCAL_ACCOUNT_NAME
 
 .. note::
 
@@ -353,36 +347,32 @@ This command asks Nexus to *download the latest bank 
statements*:
    reports).
 
 Once Nexus stored all the information in the database, the
-client can ask to actually **see** the transactions:
+client can ask to actually see the transactions:
 
 .. code-block:: console
 
-  $ libeufin-cli accounts \
-      transactions \
-        $CUSTOM_RENAMING_FOR_ACCOUNT
+  $ libeufin-cli accounts transactions $LOCAL_ACCOUNT_NAME
 
 Make a payment
 ==============
 
-..
+Payments pass through two phases: preparation and submission.  The preparation
+phase assigns the payment initiation a unique ID, which prevents accidental
+double submissions of payments in case of network failures or other
+disruptions.
 
-  FIXME: explain why payments go through these two-phases.
-
-Payments pass through two phases: preparation and submission.
 
 The following command prepares a payment:
 
 .. code-block:: console
 
-  $ libeufin-cli \
-      accounts \
-        prepare-payment \
+  $ libeufin-cli accounts prepare-payment \
           --creditor-iban $IBAN_TO_SEND_MONEY_TO \
           --creditor-bic $BIC_TO_SEND_MONEY_TO \
           --creditor-name $CREDITOR_NAME \
           --payment-amount $AMOUNT \
           --payment-subject $SUBJECT \
-          $CUSTOM_RENAMING_FOR_ACCOUNT
+          $LOCAL_ACCOUNT_NAME
 
 Note: the ``$AMOUNT`` value needs the format ``X.Y:CURRENCY``; for example
 ``10:EUR``, or ``1.01:EUR``.
@@ -393,11 +383,9 @@ in the next step, to **send the payment instructions to 
the bank**:
 
 .. code-block:: console
 
-  $ libeufin-cli \
-      accounts \
-        submit-payment \
-          --payment-uuid $UUID \
-          $CUSTOM_RENAMING_FOR_ACCOUNT
+  $ libeufin-cli accounts submit-payment \
+        --payment-uuid $UUID \
+        $LOCAL_ACCOUNT_NAME
 
 Automatic scheduling
 ====================
@@ -452,12 +440,10 @@ INI and HIA secret keys will be restored for the 
requesting user.
 
 .. code-block:: console
 
-  $ libeufin-cli \
-      connection \
-        restore-backup \
-          --passphrase $SECRET \
-          --backup-file $BACKUP_FILE \
-          $CONNECTION_NAME
+  $ libeufin-cli connection \ restore-backup
+      --passphrase $SECRET \
+      --backup-file $BACKUP_FILE \
+      $CONNECTION_NAME
 
 Creating a Taler facade
 =======================
@@ -473,12 +459,10 @@ existing bank account / connection pair.
 
 .. code-block:: console
 
-  $ libeufin-cli \
-      facades \
-        new-facade \
-          --facade-name $FACADE_NAME \
-          $CONNECTION_NAME \
-          $CUSTOM_RENAMING_FOR_ACCOUNT
+  $ libeufin-cli facades new-facade \
+      --facade-name $FACADE_NAME \
+      $CONNECTION_NAME \
+      $LOCAL_ACCOUNT_NAME
 
 At this point, the additional *taler-wire-gateway* (FIXME: link
 here to API here) API becomes offered by the Nexus.  The purpose

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