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 PR adds a
description
field on base-type, which serves to take the descriptive burden offname
so that it can more properly be used to identify types for the purposes of rendering them.For schema generators already in the code base where such specializations do not warrant a distinct
name
(string derivatives and number derivatives), the newdescription
field is used instead.For schema generators for more complicated types (array, either, dictionary)
name
is constant anddescription
takes the burden of describing child schema.The codebase has been reviewed for any opportunities to include information in the schema itself rather than guess what type it is (i.e., make schemas more characteristic). I think I managed to get them all, but in reviewing, I do think the
choice
type might be better reworked into a type more properly than through assertions.To do: