Improve documentation on canonical

This commit is contained in:
pietervdvn 2022-07-26 12:05:34 +02:00
parent a86e52ec63
commit aea1d0335c

View file

@ -756,8 +756,8 @@ export default class SpecialVisualizations {
},
{
funcName: "canonical",
docs: "Converts a short, canonical value into the long, translated text",
example: "{canonical(length)} will give 42 metre (in french)",
docs: "Converts a short, canonical value into the long, translated text including the unit. This only works if a `unit` is defined for the corresponding value. The unit specification will be included in the text. ",
example: "If the object has `length=42`, then `{canonical(length)}` will be shown as **42 meter** (in english), **42 metre** (in french), ...",
args: [{
name: "key",
doc: "The key of the tag to give the canonical text for",