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

Field name and value #54

Open
MikeBishop opened this issue Jul 19, 2023 · 3 comments
Open

Field name and value #54

MikeBishop opened this issue Jul 19, 2023 · 3 comments

Comments

@MikeBishop
Copy link

We explicitly say not to <tt> / ` field names on reference. Do we want that enclosure when we're explicitly citing a field name and value pair? That is:

...by sending a Vary: Client-Cert response header.

or

...by sending a "Vary: Client-Cert" response header.

or

...by sending a Vary: Client-Cert response header.

I'm inclined to think that quotes are the most clear, since they appear in the text output, but ignoring text output my preference would be for <tt>

@mnot
Copy link
Member

mnot commented Jul 19, 2023

Yeah, in a perfect world, we'd use tt, but the text output is not great. Personally, I'd lean towards quotes, although that may result in some confusing constructs (eg if the field value ends in quotes, or contains lots of them).

@MikeBishop
Copy link
Author

MikeBishop commented Jul 19, 2023

From a cursory search of the RFC 911X documents, it appears that full fields (name + value) are usually set out as an illustration similar to http-message objects. The exception I've found so far was:

Because the meaning of "Pragma: no-cache" in responses was never specified, it does not provide a reliable replacement for "Cache-Control: no-cache" in them.

So obviously we went quotes there. Perhaps something like this....

When referring to a full field, i.e. a name and value together, the reference can be inlined or set apart as an illustration. When set apart, see Example Messages below. When inlined, the full field should be surrounded by quotes. If the field value includes quotes, it's preferable to use the illustration formatting. If inlining can't be avoided, use single quotes.

@mnot
Copy link
Member

mnot commented Jul 19, 2023

That seems like a reasonable rule of thumb: examples should generally be in http-message sections, unless they're so simplie that they're unambiguous in quotes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants