From 9830ea631480cefcb8783707dd1cf3267c9bb98a Mon Sep 17 00:00:00 2001 From: habere-et-dispertire Date: Fri, 25 Aug 2023 19:58:31 +0100 Subject: [PATCH 1/2] ...facilitates documentation *and translation*. --- .../javascript/general/replace_magic_with_identifier.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/analyzer-comments/javascript/general/replace_magic_with_identifier.md b/analyzer-comments/javascript/general/replace_magic_with_identifier.md index d1bfc5675..061274dfd 100644 --- a/analyzer-comments/javascript/general/replace_magic_with_identifier.md +++ b/analyzer-comments/javascript/general/replace_magic_with_identifier.md @@ -8,5 +8,5 @@ When possible, named constants are often a better choice than inlined literals b The programmer might infer the meaning after reading the code carefully, but it is not obvious. Magic values become particularly confusing when the same value is used for different purposes in one section of code. - It is easier to alter the value, as it is not duplicated. -- It encourages and facilitates documentation. +- It encourages and facilitates documentation and translation. - It aids with autocompletion in many IDEs. From 68e87a18b5093ae4069033172941edec234dc17c Mon Sep 17 00:00:00 2001 From: habere-et-dispertire Date: Fri, 25 Aug 2023 19:59:25 +0100 Subject: [PATCH 2/2] ...facilitates documentation *and translation*. --- .../typescript/general/replace_magic_with_identifier.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/analyzer-comments/typescript/general/replace_magic_with_identifier.md b/analyzer-comments/typescript/general/replace_magic_with_identifier.md index d1bfc5675..061274dfd 100644 --- a/analyzer-comments/typescript/general/replace_magic_with_identifier.md +++ b/analyzer-comments/typescript/general/replace_magic_with_identifier.md @@ -8,5 +8,5 @@ When possible, named constants are often a better choice than inlined literals b The programmer might infer the meaning after reading the code carefully, but it is not obvious. Magic values become particularly confusing when the same value is used for different purposes in one section of code. - It is easier to alter the value, as it is not duplicated. -- It encourages and facilitates documentation. +- It encourages and facilitates documentation and translation. - It aids with autocompletion in many IDEs.