Skip to content

Update guidance to not require a noun with an object name in all cases #631

@julian-cable

Description

@julian-cable

Chat thread:
https://redhat-internal.slack.com/archives/C06DRCC1NDS/p1736311613893709

Although in most cases we'd use an object name followed by a noun, in some cases it results in awkward and stilted language.

(From David:)
For example, instead of "the false value of the is:clear key means that you need to improve your writing".
If I rephrased that...
"The is:clear key is set to false, which means that your writing needs improvement."
or:
"The value of is:clear is false, blah blah..."
There's a few different ways to write these things, but in that original example, insisting on using "value" afterwards is not doing anyone any favors IMO.

Update the guidance to https://stylepedia.net/style/#refer-object-names to allow for this usage.

Metadata

Metadata

Assignees

Labels

enhancementWill improve the guide but is not a bug or blocker.

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions