summaryrefslogtreecommitdiff
path: root/core/api-common.rst
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2020-03-19 20:36:38 +0530
committerFlorian Dold <florian.dold@gmail.com>2020-03-19 20:36:38 +0530
commit35a76e230cede840f43dd94e0b7fe6dd083973fd (patch)
tree567918a0e0477533d298894bf0d07eba750c622a /core/api-common.rst
parent165ba5b8ae834f432d12345be38ffc859df9f609 (diff)
downloaddocs-35a76e230cede840f43dd94e0b7fe6dd083973fd.tar.gz
docs-35a76e230cede840f43dd94e0b7fe6dd083973fd.tar.bz2
docs-35a76e230cede840f43dd94e0b7fe6dd083973fd.zip
fix doc bugs (found by Torsten)
Diffstat (limited to 'core/api-common.rst')
-rw-r--r--core/api-common.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/core/api-common.rst b/core/api-common.rst
index 8a885f0..dfe9cc3 100644
--- a/core/api-common.rst
+++ b/core/api-common.rst
@@ -317,18 +317,19 @@ Internally, amounts are parsed into the following object:
.. ts:def:: ParsedAmount
interface ParsedAmount {
- // name of the currency using either a three-character ISO 4217 currency
+ // Name of the currency using either a three-character ISO 4217 currency
// code, or a regional currency identifier starting with a "*" followed by
// at most 10 characters. ISO 4217 exponents in the name are not supported,
// although the "fraction" is corresponds to an ISO 4217 exponent of 6.
currency: string;
- // unsigned 32 bit value in the currency, note that "1" here would
- // correspond to 1 EUR or 1 USD, depending on `currency`, not 1 cent.
+ // Non-negative integer value in the currency, can be at most 2^52.
+ // Note that "1" here would correspond to 1 EUR or 1 USD,
+ // depending on `currency`, not 1 cent.
value: number;
- // unsigned 32 bit fractional value to be added to ``value`` representing
- // an additional currency fraction, in units of one millionth (1e-6)
+ // Unsigned 32 bit fractional value to be added to ``value`` representing
+ // an additional currency fraction, in units of one hundred millionth (1e-8)
// of the base currency value. For example, a fraction
// of 500,000 would correspond to 50 cents.
fraction: number;