Format snippet page diagnostics - #1314
Draft
danielporterda wants to merge 1 commit into
Draft
Conversation
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
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
1 participant
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.
What changed
Adds the diagnostic value used to report snippet authoring failures with repository path, line, column, stable code, message, and optional remediation.
This PR only defines and tests rendering. It does not map validation issues to codes or add the local-ref remediation text.
Why
The previously vague “page/line diagnostics” behavior is now one explicit, independently reviewable output contract.
Validation
python -m pytest tests/test_snippet_diagnostic_format.py(2 passed)python -m ruff check scripts/snippets/model.py tests/test_snippet_diagnostic_format.pypython -m mypy scripts/snippets/model.pygit diff --check