Reorganize CC docs #23709
Open
Reorganize CC docs #23709
+1,462
−1,178
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
If the closure has an expected function type with a fully defined result type, take the internalized result type as the local return type of the closure. This has the effect that some conformance tests are now done with Fresh instead Result caps. This means a now can widen a local reference to a result cap, since the comparison is done between the local reference and the internalized FreshCap. Previously this failed since we compared a local cap with result cap, and result caps only subtype other result caps. It also propagates types more aggressively into closure bodies, which sometimes reduces the error span and improves the error message.
- Special case in some situations so that we only print the name, not the underlying type. - Print TermParamRefs like other singleton types
- Split doc page into individual sub-pages - Add new material on classifiers - Revise material on scoped caps TODO - Revise material on reach capabilities - Add material on how to use the capture checker - Add material on separation checking - Check everything for completeness and accuracy Also: Add two test files named `reference-cc.scala` in neg and pos that let us try out the code on the doc pages. TODO: Complete these files so that all relevant code is there.
Files should also be listed in sidebar.yml.
Replaced hand-written intra-doc links with automatic doctool linking. Sidebar now reflects the subsection hierarchy.
Also remove redundant headings
The first paragraph of a doc page is rendered as some sort of synopsis/subtitle, which looked awkward with the current text. This change adds introduction headings, which also improves the navigation on the right-hand side of a page.
This has to be in sync with `docs/sidebar.yml`
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.
TODO
Also: Add two test files named
reference-cc.scalain neg and pos that let us try out the code on the doc pages.TODO: Complete these files so that all relevant code is there.
Based on #23701