diff options
author | Florian Dold <florian.dold@gmail.com> | 2020-01-06 19:42:45 +0100 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2020-01-06 19:42:45 +0100 |
commit | 5251c18e98e2831001f183cbc9fab72aa063e206 (patch) | |
tree | 1c268ac92655de7cf2fef9491b677b0188bece05 /developers-manual.rst | |
parent | 11422f272da8f74c3b46552067905e061f220707 (diff) | |
download | docs-5251c18e98e2831001f183cbc9fab72aa063e206.tar.gz docs-5251c18e98e2831001f183cbc9fab72aa063e206.tar.bz2 docs-5251c18e98e2831001f183cbc9fab72aa063e206.zip |
minor doc fixes, start words to use/avoid dictionary
Diffstat (limited to 'developers-manual.rst')
-rw-r--r-- | developers-manual.rst | 33 |
1 files changed, 32 insertions, 1 deletions
diff --git a/developers-manual.rst b/developers-manual.rst index 188a7c04..a252f756 100644 --- a/developers-manual.rst +++ b/developers-manual.rst @@ -471,6 +471,7 @@ the change of the version. Update the Texinfo documentation using the files from docs.git: .. code-block:: + # Get the latest documentation repository cd $GIT/docs git pull @@ -497,7 +498,7 @@ Update the Texinfo documentation using the files from docs.git: git checkout $REVISION Finally, the Automake ``Makefile.am`` files may have to be adjusted to -include new *.texi files or images. +include new ``*.texi`` files or images. For the exchange test cases to pass, ``make install`` must be run first. @@ -773,3 +774,33 @@ to tamper with the data exchanged by A and B. Please refer to the Twister codebase (under the ``test`` directory) in order to see how to configure it. + + +User-Facing Terminology +======================= + +This section contains terminology that should be used and that should not be +used in the user interface and help materials. + +Terms to Avoid +-------------- + +Refreshing + Refreshing is the internal technical terminology for the protocol to + give change for partially spent coins + + **Use instead**: "Obtaining change" + +Coin + Coins are an internal construct, the user should never be aware that their balance + is represented by coins if different denominations. + + **User instead**: "(Digital) Cash" or "Wallet Balance" + + +Terms to Use +------------ + +Refund + A refund is given by a merchant to the customer (rather the customer's wallet) + and "undoes" a previous payment operation. |