Skip to content

Add guidance for 'named' and 'called' #591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 8, 2024
Merged

Add guidance for 'named' and 'called' #591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e55f249
Add guidance for 'named' and 'called'
julian-cable Jul 4, 2024
733025a
Further edit
julian-cable Jul 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions en-US/C.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,23 @@
<chapter id="c">
<title>C</title>
<variablelist>
<varlistentry id="called">
<term>call, called</term>
<listitem>
<para>
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."
</para>
<para>
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.
</para>
<para>
Refer also to <xref linkend="named" />.
</para>
</listitem>

</varlistentry>
<varlistentry id="can-may">
<term>can, may</term>
<listitem>
Expand Down
19 changes: 19 additions & 0 deletions en-US/N.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,25 @@
<chapter id="n">
<title>N</title>
<variablelist>
<varlistentry id="named">
<term>named</term>
<listitem>
<para>
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 <filename>configurations</filename> to keep your workspace organized."
</para>
<para>
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.
</para>
<para>
Refer also to <xref linkend="called" />.
</para>
</listitem>

</varlistentry>
<varlistentry id="navigate-to">
<term>navigate to</term>
<listitem>
Expand Down