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

Notational conventions aren't the place to discuss #231

Merged
merged 3 commits into from Oct 24, 2022

Conversation

LPardue
Copy link
Member

@LPardue LPardue commented Sep 12, 2022

There's too much text here that doesn't aid the reader. Delete it to be
clear that we're using JSON as the notational convention for examples.

If this text was valuable, it should be somewhere else.

There's too much text here that doesn't aid the reader. Delete it to be
clear that we're using JSON as the notational convention for examples.

If this text was valuable, it should be somewhere else.
tips and requirements for these are also listed in this document
({{concrete-formats}}).
The qlog schema can be serialized in many ways (e.g., JSON, CBOR, protobuf,
etc). Serialization examples in this document use JSON ({{!JSON=RFC8259}}).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll keep the definition of serialization example using JSON. But we need to keep the talk about serialization considerations somewhere else

@rmarx
Copy link
Contributor

rmarx commented Oct 21, 2022

I still feel we should have a "forward reference" here, indicating that we also discuss I-JSON and Streaming JSON considerations in this document, rather than making it seem we only do "pure JSON" due to the examples.

Put differently, something like this should still be mentioned in this location imo:

This document describes how to employ {{!JSON=RFC8259}}, its subset
{{!I-JSON=RFC7493}}, and its streamable derivative
{{!JSON-Text-Sequences=RFC7464}}.

@LPardue
Copy link
Member Author

LPardue commented Oct 21, 2022

But the fact it can be serialized to I-JSON has nothing to do with notational conventions used in this document, because we don't use any I-JSON.

@rmarx rmarx requested review from rmarx and removed request for lnicco, marten-seemann and rmarx October 24, 2022 12:08
@rmarx
Copy link
Contributor

rmarx commented Oct 24, 2022

@LPardue I just pushed a commit with a proposal to split up the original text to keep only a minimal amount in "Notational Conventions" but keep the core message alive in the introduction (which seemed the most logical location for now).

I added the "unless otherwise indicated", as there are some examples of JSON-SEQ near the end of the document that obviously don't use RFC8259 notation directly.

Please review and if approved, merge :)

@LPardue LPardue merged commit 0628832 into main Oct 24, 2022
@LPardue LPardue deleted the simplify-serialization-notation branch October 24, 2022 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants