Add guidance around use of title and description keywords #157
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.
Related to #142, which references that "Type title will not change."
I still agree with this, but don't think we should define type titles using the
title
keyword. Instead, thetitle
should be sourced from the key values withing$defs
. For example, given the following frommeter_provider.json
, the periodic metric reader's title isPeriodicMetricReader
. See PR content for reasoning.