Skip to content
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.

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

style: headers *and* trailers #30

Open
LPardue opened this issue Feb 27, 2022 · 1 comment
Open

style: headers *and* trailers #30

LPardue opened this issue Feb 27, 2022 · 1 comment
Labels
style-guide Discussion of the style guide

Comments

@LPardue
Copy link
Contributor

LPardue commented Feb 27, 2022

In https://github.com/httpwg/admin/blob/main/style-guide.md#header-and-trailer-fields the guidance says

If the field is specific to headers, trailers, requests, and/or responses, the definition should include the relevant terms, as above.

and

Subsequent occurrences should be unquoted, but always be followed by "field", "header field", or "trailer field" as appropriate.

Content-Digest, for example, is all of these things. So ends up being defined as "the Content-Digest request and response header and trailer field". We refreain from saying "header and trailer" everywhere though. Should we really just be saying "field" or does that gloss over the definition of the field too much?

Perhaps the style guide would benefit from the explicit counter case in the guidance along the lines of "if a field applies to multiple categories, those categories can be ommited and only "field" used. Or some other guidance if I'm not on the money,

@mnot
Copy link
Member

mnot commented Feb 27, 2022

Content-Digest, for example, is all of these things. So ends up being defined as "the Content-Digest request and response header and trailer field"

Not necessarily. I'd construct it as:

The Content-Digest field can occur in request and response messages, in the header or trailer section.

@mnot mnot added the style-guide Discussion of the style guide label Feb 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
style-guide Discussion of the style guide
Development

No branches or pull requests

2 participants