handrews-*-01 bugfix for core & validation #555
Merged
Conversation
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
The main HTML rendering of the spec on the IETF site (and the plain text rendering) put the first line of a hanging text body on the same line as the label. When the bodies are each a single line, this looks like a weird spacing error rather than a labeled list. Use colons to make these lists more listy. This is *not* done with the body is itself a list, as the plain text formatting handles that in a way that is already clear, and the colon looks odd particularly for the list where the labels are JSON Pointers.
We're no longer likely to drop it, but we are likely to split it. This was successful in provoking feedback before so let's keep it up to date.
This is a purely bugfix / wording change, with no funcitonal changes or meta-schema changes.
While we were at one point going to use "uri-ref", by the time we actually published draft-wright-json-schema-validation-01 we had decided on "uri-reference".
Relequestual
approved these changes
Mar 8, 2018
philsturgeon
approved these changes
Mar 8, 2018
|
Oh I'm surprised I didn't see this. This is mostly fine except afaict the colon isn't supposed to be provided in labels. I think that's just the style of RFCs, maybe there's an argument to affect the display? Doesn't matter too much. The RFC Editor can yell at us once we that far. |
|
@awwright ugh it's confusingly unreadable without them in most cases- it just looks like badly done spacing. We can take them out when we have to. |
gregsdennis
added
clarification
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.
This makes the draft numbering change and adds the change log for doing a clarification / bugfix draft of core and validation. The changes include:
$idand$ref(previously merged: Remove internal/external reference terminology, expand use cases and examples #550 and Core: Improve language for schema references section #551)if/then/else(Fix missing "if present" for "else" #554)dependencies(second commit of this PR)The usefulness of the
$id/$refclarifications in core should be readily apparent.For validation, the
ifchange seems worth publishing because a.) I've received two separate complaints/questions about it, and b.) the validation spec would otherwise be the only one still on handrews-00 so we might as well publish an update even though it's very small. It does address a real-world point of confusion.As with the draft-*-handrews-01 for hyper-schema and relative JSON pointer, there are no functional changes here, and no changes to the meta-schema.