Encode the known-issue comment in JSON if present.#1623
Merged
Conversation
This PR adds an unsupported/experimental field to the JSON encoding of an issue to contain the comment provided by the developer as an argument to `withKnownIssue()`. We'll need to figure out how this property fits into the supported JSON schema. Is there prior art in other libraries for XFAIL-specific comments, for instance?
grynspan
requested review from
briancroom,
harlanhaskins,
jerryjrchen and
stmontgomery
as code owners
grynspan
added
enhancement
harlanhaskins
approved these changes
Mar 10, 2026
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
2 participants
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 unsupported/experimental field to the JSON encoding of an issue to contain the comment provided by the developer as an argument to
withKnownIssue().We'll need to figure out how this property fits into the supported JSON schema. Is there prior art in other libraries for XFAIL-specific comments, for instance?
Checklist: