Tidy up schema titles and descriptions#45
Merged
Conversation
Automated Review URLs |
Contributor
|
@dstansby +1 for adding more details to these useful fields. I feel the descriptions could be a bit expanded? In the simplest sense, the description could just be the first sentence from the spec text itself, i.e.:
if that makes sense to you? For some of the fields, there's obviously not that much to be written, though. |
jo-mueller
approved these changes
Jan 13, 2026
Member
|
Thanks, @dstansby. |
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
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 tidies up the title and description fields in the schemas to make them consistent. In particular:
I'm hoping this is a good start to improving the schema documentation website by making the titles shorter and descriptions more descriptive.