Open
Description
We need to make sure that the documentation at https://dotty.epfl.ch/docs/reference/overview.html is sound and complete with respect to the release candidate.
In this umbrella issue, we can collect necessary changes. Feel free to edit the issue text or add comments if you think something needs to be changed.
I propose the following categorisation of changes.
Incomplete / Incorrect Documentation
Features where some documentation is missing or need to be changed in details.
- Polymorphic Function Types PR, solved by Document polymorphic function types #10663
- Braceless Syntax (Issue Documentation is unclear about new brace-less syntax #10648), solved by Fix #10648: Fixes of syntax documentation #10658
- Union type spec mentions "When inferring the result type of a definition (val, var, or def) and the type we are about to infer is a union type, then we replace it by its join" this is no longer always true with Fix #10108: Distinguish between soft and hard union types #10112
- Documentation on kind polymorphism lacks a "concise example" (it mentions a todo)
- The documentation of implicit resolution uses
implicit
syntax (should it mention that this is deprecated?) -- it also has a todo "expand with precise rules". - Docs on using parameters on classes should mention given instances (Document using parameters on classes can provide given instances #10882)
Missing Features
Features that are not documented at all.
-
@static
-
new {}
, see Decide on status ofnew {}
#10637 -
extends ... , ...
: explained in Update syntax in docs #10635 -
catch case ...
: explained in Update syntax in docs #10635 - tuples implemented with match types
- changes in type checking (Issue Fill in "Changes in type checking/inference" sections #10759)
- changes in type-inference
Deprecated Features
Features that are documented but will not be part of the release.
Other Aspects
- update all of the documentation to indentation based syntax (once it has been formally accepted) to be consistent with the other resources (Scala 3 book etc.).
- once we move the reference docs to another location, we also need to change the doc-comments (like the ones here)