scaladoc: support expectations in snippets#25713
Open
bracevac wants to merge 2 commits intoscala:mainfrom
Open
scaladoc: support expectations in snippets#25713bracevac wants to merge 2 commits intoscala:mainfrom
bracevac wants to merge 2 commits intoscala:mainfrom
Conversation
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.
Fixes #25647
This adds compiler-suite-style diagnostic expectations for checked scaladoc snippets.
Supported:
// error// warn// error // errorHow to enable it:
compile+testfor the markdown file in scaladoc'ssnippetCompiler/-snippet-compilerconfigurationdocs/_docs/reference/experimental/capture-checking/basics.md=compile+testHow to use it:
In
compile+testmode:Not ported:
// anypos-errorUseful in the compiler test suite for awkward parser/scanner cases, but not a good fit for scaladoc.
// nopos-error/// nopos-warnPosition-less diagnostics don't arise in self-contained documentation snippets (they occur in multi-file macro scenarios), so these annotations have no practical use here.
sc-check:<id>A poor fit for docs, since it checks wrapped compiler output rather than the focused excerpts we want to show in documentation.
How much have you relied on LLM-based tools in this contribution?
A lot.
How was the solution tested?
Automated tests, plus manual testing on the CC language reference.