Super-fy the Super Binary format doc #5387
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mccanne
approved these changes
Oct 30, 2024
| @@ -34,7 +34,7 @@ an S3 URL, or standard input specified with `-`. | |||
| For built-in command help and a listing of all available options, | |||
| simply run `zq` with no arguments. | |||
|
|
|||
| `zq` supports a number of [input](#input-formats) and [output](#output-formats) formats, but [ZNG](../formats/zng.md) | |||
| `zq` supports a number of [input](#input-formats) and [output](#output-formats) formats, but [Super Binary](../formats/bsup.md) | |||
| tends to be the most space-efficient and most performant. ZNG has efficiency similar to | |||
docs/formats/bsup.md
Outdated
|
|
||
| The body of a control frame is a control message and may be JSON, | ||
| Super JSON, Super Binary, arbitrary binary, or UTF-8 text. The serialization of the control | ||
| frame body is independent of the Super JSON stream containing the control | ||
| frame body is independent of the Super Binary stream containing the control |
There was a problem hiding this comment.
This is referring to embedded Super JSON inside of Super Binary so you shouldn't change JSON to Binary here.
There was a problem hiding this comment.
@mccanne and I talked offline about this one and confirmed that it's a reference to the Super Binary stream after all, but we can just drop the reference to "Super Binary" here entirely.
docs/libraries/python.md
Outdated
| @@ -13,7 +13,7 @@ The Python client interacts with the Zed lake via the REST API served by | |||
| [`zed serve`](../commands/zed.md#serve). | |||
|
|
|||
| This approach works adequately when high data throughput is not required. | |||
| We will soon introduce native [ZNG](../formats/zng.md) support for | |||
| We will soon introduce native [Super Binary](../formats/bsup.md) support for | |||
There was a problem hiding this comment.
"we plan to" instead of "soon"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the same spirit as #5368.
Details
As with other recent super-fying docs PRs, I've selectively removed some excess repeats, i.e., since the three-letter "ZNG" was cheap to say, it was sometimes used multiple times in the same sentence and didn't seem to hurt the flow, but turning each of those into "Super Binary" starts to look a little long-winded. That said, since this is a formal spec, I didn't push it too hard because I figured absolute technical correctness wins out over casual readability here. But if anyone spots more repeats in here you think are worth dropping, please point them out!