Scaladoc Support for Capture & Separation Checking #23471
Draft
+603
−51
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
[skip ci]
We should not propagate the capture status beyond the current arrow. Under a capture context, types are rendered plainly.
bracevac
changed the title
The information that we are within a capture context was not propperly passed to recursive calls of `inner`, which caused some types to be rendered incorrectly. This was due to a bad interplay with implicit parameters and default arguments.
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.
[skip ci]
This'll fix #23437 (eventually, patience plz)
The PR should not be merged as such, since there are a few additions
and changes to the build files as well as development files & folders that do not belong into the main branch.
TODOs
update@consume,@use.rdI think for now, let's have a separate API doc for CC enabled. A follow-up PR can investigate how to have one doc and a toggle on the page. This also depends to some extent on the effort to have a Scala 3 library artifact #22043 as well as having the rest of the standard library capture checked.
Trying it Out
scaladoc/generateScalaDocumentationinsbt, go to./scaladoc/output, and run an HTTP server from there to browse the API for the capture-checked stdlib../local/project. Insbt, invokemyrefreshwhich will compile the example project and then run scaladoc on it. The scaladoc output is in./local/apiand can be viewed using a local HTTP server.myrefreshafterwards for the up-to-date scaladoc.myscaladocinsbt.