Skip to content

Add guidance on use of object names #389

@julian-cable

Description

@julian-cable

Add to https://stylepedia.net/style/5.1/#refer-object-names:

Guidance to add:
"Avoid starting or ending a sentence with an object name."

Original example 1:
"Umount /mnt/save."

Improvement example 1:
"Unmount the /mnt/save directory."

Original example 2:
"Modify the /etc/resolv.conf file to use this nameserver."

Improvement example 2:
"Modify the /etc/resolv.conf file to use this name server."

=====
Object name order:
Prefer "the <name> object" to "the object <name>".

Original example:
"Enable the default module stream for the module python36 and install all packages from that stream."

Improvement example:
"Enable the default module stream for the python36 module and install all packages from that stream."

Metadata

Metadata

Assignees

Labels

WIPWorking on it. Branch probably exists.enhancementWill improve the guide but is not a bug or blocker.

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions