httpwg / admin

When you want to speak to the manager.
9 stars 15 forks source link

style: referencing fields from other documents #32

Open LPardue opened 2 years ago

LPardue commented 2 years ago

When one document references a field defined in another document, is there any preference of style? For example, should I say

mnot commented 2 years ago

I think it'd just be

the Content-Location header field [ref]

mnot commented 2 years ago

(on first occurrence)

MikeBishop commented 2 years ago

And what about pseudo-header fields? The style guide says no quotes except when defining for header fields, and I'm inclined to follow that, but the fact that pseudo-headers don't have a title-casing convention and begin with a non-letter character makes them feel substantially more awkward in the text. If nothing else, the style guide should explicitly cover that case.

mnot commented 2 years ago

How does that look?