Updating docs at dotty.epfl.ch

b-studios commented 3 years ago

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.

[x] Polymorphic Function Types PR, solved by #10663
[x] Braceless Syntax (Issue #10648), solved by #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 https://github.com/lampepfl/dotty/pull/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 (#10882)

Missing Features

Features that are not documented at all.

[ ] @static
[ ] new {}, see #10637
[X] extends ... , ...: explained in #10635
[X] catch case ...: explained in #10635
[ ] tuples implemented with match types
[ ] changes in type checking (Issue #10759)
[ ] changes in type-inference

Deprecated Features

Features that are documented but will not be part of the release.

[ ] Named Typeargs

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)

LPTK commented 3 years ago

I could write some documentation for polymorphic function types, if no one else is going to do it.

japgolly commented 3 years ago

Got another one: #11766

scala / scala3