Add ADR excluding examples from object descriptions #391
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
ahouseholder
requested review from
cgyarbrough,
sei-vsarvepalli and
j---
as code owners
ahouseholder
added
documentation
j---
approved these changes
Nov 17, 2023
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 PR adds an ADR that says we're deliberately excluding examples from object descriptions. Rationale is laid out in the ADR file added, but basically it comes down to
descriptionfield of an object to give enough information to distinguish it from others without placing the expectation that thedescriptionfield is full documentation.We've run into this a few times already with other decision points, but the CVSS modeling work in #377 has really highlighted the value of keeping descriptions more terse.