-
Notifications
You must be signed in to change notification settings - Fork 21
Closed
Labels
WIPWorking on it. Branch probably exists.Working on it. Branch probably exists.enhancementWill improve the guide but is not a bug or blocker.Will improve the guide but is not a bug or blocker.
Milestone
Description
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.Working on it. Branch probably exists.enhancementWill improve the guide but is not a bug or blocker.Will improve the guide but is not a bug or blocker.