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.

Sign up for GitHub

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

Jump to bottom

"field names" vs "member names" vs. "object member names" #340

Closed
LPardue opened this issue Nov 13, 2023 · 1 comment · Fixed by #362
Closed

"field names" vs "member names" vs. "object member names" #340

LPardue opened this issue Nov 13, 2023 · 1 comment · Fixed by #362
Labels
editorial

Comments

@LPardue
Copy link
Member

LPardue commented Nov 13, 2023

From PR #289:

I've called this "field names" consistently throughout the qlog documents. However, double-checking this with the JSON RFC at https://www.rfc-editor.org/rfc/rfc8259#section-4, they use "member names" or "object member names" instead.

I'm not sure that makes things any clearer for readers unfamiliar with JSON terminology, and changing things would be a big overall update across the docs, but potentially worth it for consistency? Either way, would require a new issue/PR.

Originally posted by @rmarx in #289 (comment)
@LPardue LPardue mentioned this issue Nov 13, 2023
Merged
LPardue added a commit that referenced this issue Dec 9, 2023
@LPardue
Rephrase qlog field serialization rules
2e5186b 
This avoids any ambiguity about what we are talking about, avoiding
the need to import JSON terms.

Closes #340
@LPardue LPardue mentioned this issue Dec 9, 2023
Merged
@LPardue
Copy link
Member Author

LPardue commented Dec 9, 2023

I like the term qlog field names, especially as we want the qlog schema to be serialization format independent. Therefore I don't think we need to use JSON terminology. I made #362 as a way to make the sentences a bit cripser - but I could equally live without it.

LPardue added a commit that referenced this issue Dec 19, 2023
@LPardue
Rephrase qlog field serialization rules (#362)
3398abe 
This avoids any ambiguity about what we are talking about, avoiding
the need to import JSON terms.

Closes #340
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
editorial
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Rephrase qlog field serialization rules quicwg/qlog
1 participant
@LPardue