Document JSON formats #9348
Merged
Document JSON formats #9348
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
Ericson2314
force-pushed
the
json-formats
branch
from
2ff299d to
b3fbff0
Compare
Draft
Ericson2314
force-pushed
the
json-formats
branch
from
b3fbff0 to
d0a5251
Compare
Ericson2314
force-pushed
the
json-formats
branch
2 times, most recently
from
1843c07 to
31b215a
Compare
fricklerhandwerk
approved these changes
Jan 19, 2024
Ericson2314
force-pushed
the
json-formats
branch
2 times, most recently
from
c61c56a to
ddc5321
Compare
Good to document these formats separately from commands that happen to use them. Eventually I would like this and `builtins.derivation` to refer to a store section on derivations that is authoritative, but that doesn't yet exist, and will take some time to make. So I think we're just best off merging this now as is. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Ericson2314
force-pushed
the
json-formats
branch
from
ddc5321 to
edf3ecc
Compare
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.
Motivation
Good to document these things separately from commands.
TODO mention these are both currently unstable. Indeed they both currently violate the JSON guidelines.Context
#9242 #7887 pulled out the underlying serializers, now we can document!
Eventually I would like this and
builtins.derivationto refer to a store section on derivations that is authoritative, but that doesn't yet exist, and will take some time to make. So I think we're just best off merging this now as is.Priorities
Add 👍 to pull requests you find important.