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: referencing fields from other documents #32

Open
LPardue opened this issue Feb 27, 2022 · 4 comments
Open

style: referencing fields from other documents #32

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

Comments

@LPardue
Copy link
Contributor

LPardue commented Feb 27, 2022

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

  • the "Content-Location" header field

  • the "Content-Location" field

  • the Content-Location header field

  • the Content-Location field

  • ...
@mnot
Copy link
Member

mnot commented Feb 27, 2022

I think it'd just be

the Content-Location header field [ref]

@mnot
Copy link
Member

mnot commented Feb 27, 2022

(on first occurrence)

@mnot mnot added the style-guide Discussion of the style guide label Feb 27, 2022
@MikeBishop
Copy link

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 added a commit that referenced this issue Apr 19, 2022
@mnot
Copy link
Member

mnot commented Apr 19, 2022

How does that look?

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

3 participants