From aea1d0335c0b25c2bb02e923adeed8e2436c6ad2 Mon Sep 17 00:00:00 2001 From: pietervdvn Date: Tue, 26 Jul 2022 12:05:34 +0200 Subject: [PATCH] Improve documentation on canonical --- UI/SpecialVisualizations.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/UI/SpecialVisualizations.ts b/UI/SpecialVisualizations.ts index 4d70c850c..f2f0f93ef 100644 --- a/UI/SpecialVisualizations.ts +++ b/UI/SpecialVisualizations.ts @@ -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",