docs: clarify some things in README, update version compatibility matrix#46
Merged
jvanstraten merged 1 commit intosubstrait-io:mainfrom Aug 30, 2022
Merged
Conversation
vibhatha
reviewed
Aug 30, 2022
README.md
Outdated
| interesting to try a plan that *isn't* valid, but we'll leave that as an | ||
| excercise to the reader. | ||
| excercise to the reader. Note that the validator supports other file types as | ||
| well, including JSON, [JDOT](https://github.com/saulpw/jdot), and of course |
There was a problem hiding this comment.
Suggested change
| well, including JSON, [JDOT](https://github.com/saulpw/jdot), and of course | |
| well, including JSON, [JDOT](https://github.com/saulpw/jdot), and of course, |
Collaborator
Author
There was a problem hiding this comment.
Removed "of course" altogether.
vibhatha
reviewed
Aug 30, 2022
README.md
Outdated
| `--mode ignore` tells the validator to emit a file and exit with code 0 | ||
| regardless of the validation result. The full list of modes is: | ||
| The validator only emits an output file if it exits with code 0, and exits | ||
| with code 1 if validation fails, in order to play nicely with build systems |
There was a problem hiding this comment.
Suggested change
| with code 1 if validation fails, in order to play nicely with build systems | |
| with code 1 if validation fails, to play nicely with build systems |
Collaborator
Author
There was a problem hiding this comment.
I personally like the explicitness of "in order to" for signalling intent more than just "to", but people tend to find my writing too verbose so I'll accept this one.
vibhatha
reviewed
Aug 30, 2022
| can use this to convert between the binary protobuf serialization format | ||
| and any of the text-based formats supported by the validator. | ||
| - `ignore`: ignore the validation result (the plan still needs some level of | ||
| sanity for the validator to succeed; for example, the file must exist, and |
There was a problem hiding this comment.
Suggested change
| sanity for the validator to succeed; for example, the file must exist, and | |
| sanity for the validator to succeed; for example, the file must exist and |
Collaborator
Author
There was a problem hiding this comment.
Both are grammatically correct, but the comma signals that the two things are separate examples rather than a single one. That was my intention, so I've left this one as is.
jvanstraten
force-pushed
the
improve-readme
branch
from
b9a814f to
7d72e61
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.