From e55f249ff69377f282d87868f98506f76eb20c2b Mon Sep 17 00:00:00 2001 From: julian-cable Date: Thu, 4 Jul 2024 16:45:57 +0100 Subject: [PATCH 1/2] Add guidance for 'named' and 'called' --- en-US/C.xml | 17 +++++++++++++++++ en-US/N.xml | 19 +++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/en-US/C.xml b/en-US/C.xml index 69f34b3..27b8b6f 100644 --- a/en-US/C.xml +++ b/en-US/C.xml @@ -6,6 +6,23 @@ C + + call, called + + + Use to mean "invoked" in the context of functions or methods. + For example, "A liveness probe is called throughout the lifetime of the application." + + + On the other hand, when referring to the designation of files, objects, or entities within documentation, use the term "named" instead of "called". + This choice promotes clarity and precision in technical content. + + + Refer also to . + + + + can, may diff --git a/en-US/N.xml b/en-US/N.xml index d2fb950..19d8744 100644 --- a/en-US/N.xml +++ b/en-US/N.xml @@ -6,6 +6,25 @@ N + + named + + + When referring to the designation of files, objects, or entities within documentation, use the term "named" instead of "called". + This choice promotes clarity and precision in technical content. + The word "named" directly associates the name with the entity and is more specific in technical contexts. + Use "named" to refer to such items as a file, directory, task, user, or group. + For example, "When you need to store configuration settings, create a directory named configurations to keep your workspace organized." + + + On the other hand, "called" can imply a more casual or informal reference and might introduce ambiguity, because it can also mean "invoked" in the context of functions or methods. + + + Refer also to . + + + + navigate to From 733025ad702719a38a8a7857bdf6967dbfcc411e Mon Sep 17 00:00:00 2001 From: julian-cable Date: Thu, 4 Jul 2024 16:53:40 +0100 Subject: [PATCH 2/2] Further edit --- en-US/C.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en-US/C.xml b/en-US/C.xml index 27b8b6f..d771def 100644 --- a/en-US/C.xml +++ b/en-US/C.xml @@ -10,7 +10,7 @@ call, called - Use to mean "invoked" in the context of functions or methods. + Use to refer to code, programs, or scripts that invoke functions or methods. For example, "A liveness probe is called throughout the lifetime of the application."