Skip to content

Fix the overview of the documentation #11334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 22, 2021
Merged

Fix the overview of the documentation #11334

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6845888
Fix the overview of the documentation
ShapelessCat Feb 7, 2021
a2d5dd0
Fix a same file reference
ShapelessCat Feb 10, 2021
e1560c9
Mention the reaplcement to compound types in Overview - Dropped Const…
ShapelessCat Feb 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
147 changes: 82 additions & 65 deletions docs/docs/reference/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ In this reference, we discuss design decisions and present important differences

The language redesign was guided by three main goals:

- Strengthen Scala's foundations.
Make the full programming language compatible with the foundational work on the
[DOT calculus](https://infoscience.epfl.ch/record/227176/files/soundness_oopsla16.pdf)
and apply the lessons learned from that work.
- Make Scala easier and safer to use. Tame powerful constructs such as implicits to provide a gentler learning curve. Remove warts and puzzlers.
- Further improve the consistency and expressiveness of Scala's language constructs.
- Strengthen Scala's foundations.
Make the full programming language compatible with the foundational work on the
[DOT calculus](https://infoscience.epfl.ch/record/227176/files/soundness_oopsla16.pdf)
and apply the lessons learned from that work.
- Make Scala easier and safer to use.
Tame powerful constructs such as implicits to provide a gentler learning curve. Remove warts and puzzlers.
- Further improve the consistency and expressiveness of Scala's language constructs.

Corresponding to these goals, the language changes fall into seven categories:
(1) Core constructs to strengthen foundations, (2) simplifications and (3) [restrictions](#restrictions), to make the language easier and safer to use, (4) dropped constructs to make the language smaller and more regular, (5) [changed constructs](#changes) to remove warts, and increase consistency and usability, (6) [new constructs](#new_constructs) to fill gaps and increase expressiveness, (7) a new, principled approach to metaprogramming that replaces [Scala 2 experimental macros](https://docs.scala-lang.org/overviews/macros/overview.html).
Expand All @@ -23,30 +24,35 @@ Corresponding to these goals, the language changes fall into seven categories:

These new constructs directly model core features of DOT, higher-kinded types, and the [SI calculus for implicit resolution](https://infoscience.epfl.ch/record/229878/files/simplicitly_1.pdf).

- [Intersection types](new-types/intersection-types.md), replacing compound types,
- [Union types](new-types/union-types.md),
- [Type lambdas](new-types/type-lambdas.md), replacing encodings using structural types and type projection.
- [Context functions](contextual/context-functions.md), offering abstraction over given parameters.
- [Intersection types](new-types/intersection-types.md), replacing compound types,
- [Union types](new-types/union-types.md),
- [Type lambdas](new-types/type-lambdas.md), replacing encodings using structural types and type projection.
- [Context functions](contextual/context-functions.md), offering abstraction over given parameters.

## Simplifications

These constructs replace existing constructs with the aim of making the language safer and simpler to use, and to promote uniformity in code style.

- [Trait parameters](other-new-features/trait-parameters.md) replace [early initializers](dropped-features/early-initializers.md) with a more generally useful construct.
- [Given instances](contextual/givens.md)
replace implicit objects and defs, focussing on intent over mechanism.
- [Using clauses](contextual/using-clauses.md) replace implicit parameters, avoiding their ambiguities.
- [Extension methods](contextual/extension-methods.md) replace implicit classes with a clearer and simpler mechanism.
- [Opaque type aliases](other-new-features/opaques.md) replace most uses
of value classes while guaranteeing absence of boxing.
- [Top-level definitions](dropped-features/package-objects.md) replace package objects, dropping syntactic boilerplate.
- [Export clauses](other-new-features/export.md)
provide a simple and general way to express aggregation, which can replace the
previous facade pattern of package objects inheriting from classes.
- [Vararg patterns](changed-features/vararg-patterns.md) now use the form `: _*` instead of `@ _*`, mirroring vararg expressions,
- [Creator applications](other-new-features/creator-applications.md) allow using simple function call syntax
instead of `new` expressions. `new` expressions stay around as a fallback for
the cases where creator applications cannot be used.
- [Trait parameters](other-new-features/trait-parameters.md)
replace [early initializers](dropped-features/early-initializers.md) with a more generally useful construct.
- [Given instances](contextual/givens.md)
replace implicit objects and defs, focussing on intent over mechanism.
- [Using clauses](contextual/using-clauses.md)
replace implicit parameters, avoiding their ambiguities.
- [Extension methods](contextual/extension-methods.md)
replace implicit classes with a clearer and simpler mechanism.
- [Opaque type aliases](other-new-features/opaques.md)
replace most uses of value classes while guaranteeing absence of boxing.
- [Top-level definitions](dropped-features/package-objects.md)
replace package objects, dropping syntactic boilerplate.
- [Export clauses](other-new-features/export.md)
provide a simple and general way to express aggregation, which can replace
the previous facade pattern of package objects inheriting from classes.
- [Vararg splices](changed-features/vararg-splices.md)
now use the form `xs*` in function arguments and patterns instead of `xs: _*` and `xs @ _*`,
- [Universal apply methods](other-new-features/creator-applications.md)
allow using simple function call syntax instead of `new` expressions. `new` expressions stay around
as a fallback for the cases where creator applications cannot be used.

With the exception of [early initializers](dropped-features/early-initializers.md) and old-style vararg patterns, all superseded constructs continue to be available in Scala 3.0. The plan is to deprecate and phase them out later.

Expand All @@ -56,62 +62,69 @@ Value classes (superseded by opaque type aliases) are a special case. There are

These constructs are restricted to make the language safer.

- [Implicit Conversions](contextual/conversions.md): there is only one way to define implicit conversions instead of many, and potentially surprising implicit conversions require a language import.
- [Given Imports](contextual/given-imports.md): implicits now require a special form of import, to make the import clearly visible.
- [Type Projection](dropped-features/type-projection.md): only classes can be used as prefix `C` of a type projection `C#A`. Type projection on abstract types is no longer supported since it is unsound.
- [Multiversal Equality](contextual/multiversal-equality.md) implements an "opt-in" scheme to rule out nonsensical comparisons with `==` and `!=`.
- [infix](changed-features/operators.md)
make method application syntax uniform across code bases.
- [Implicit Conversions](contextual/conversions.md):
there is only one way to define implicit conversions instead of many, and potentially surprising implicit conversions require a language import.
- [Given Imports](contextual/given-imports.md):
implicits now require a special form of import, to make the import clearly visible.
- [Type Projection](dropped-features/type-projection.md):
only classes can be used as prefix `C` of a type projection `C#A`. Type projection on abstract types is no longer supported since it is unsound.
- [Multiversal Equality](contextual/multiversal-equality.md):
implement an "opt-in" scheme to rule out nonsensical comparisons with `==` and `!=`.
- [infix](changed-features/operators.md):
make method application syntax uniform across code bases.

Unrestricted implicit conversions continue to be available in Scala 3.0, but will be deprecated and removed later. Unrestricted versions of the other constructs in the list above are available only under `-source 3.0-migration`.


## Dropped Constructs

These constructs are proposed to be dropped without a new construct replacing them. The motivation for dropping these constructs is to simplify the language and its implementation.

- [DelayedInit](dropped-features/delayed-init.md),
- [Existential types](dropped-features/existential-types.md),
- [Procedure syntax](dropped-features/procedure-syntax.md),
- [Class shadowing](dropped-features/class-shadowing.md),
- [XML literals](dropped-features/xml.md),
- [Symbol literals](dropped-features/symlits.md),
- [Auto application](dropped-features/auto-apply.md),
- [Weak conformance](dropped-features/weak-conformance.md),
- [Compound types](new-types/intersection-types.md),
- [Auto tupling](https://github.com/lampepfl/dotty/pull/4311) (implemented, but not merged).
- [DelayedInit](dropped-features/delayed-init.md),
- [Existential types](dropped-features/existential-types.md),
- [Procedure syntax](dropped-features/procedure-syntax.md),
- [Class shadowing](dropped-features/class-shadowing.md),
- [XML literals](dropped-features/xml.md),
- [Symbol literals](dropped-features/symlits.md),
- [Auto application](dropped-features/auto-apply.md),
- [Weak conformance](dropped-features/weak-conformance.md),
- [Compound types](new-types/intersection-types.md),
- [Auto tupling](https://github.com/lampepfl/dotty/pull/4311) (implemented, but not merged).

The date when these constructs are dropped varies. The current status is:

- Not implemented at all:
- DelayedInit, existential types, weak conformance.
- Supported under `-source 3.0-migration`:
- procedure syntax, class shadowing, symbol literals, auto application, auto tupling in a restricted form.
- Supported in 3.0, to be deprecated and phased out later:
- [XML literals](dropped-features/xml.md), compound types.

- Not implemented at all:
- DelayedInit, existential types, weak conformance.
- Supported under `-source 3.0-migration`:
- procedure syntax, class shadowing, symbol literals, auto application, auto tupling in a restricted form.
- Supported in 3.0, to be deprecated and phased out later:
- [XML literals](dropped-features/xml.md), compound types.

## Changes

These constructs have undergone changes to make them more regular and useful.

- [Structural Types](changed-features/structural-types.md): They now allow pluggable implementations, which greatly increases their usefulness. Some usage patterns are restricted compared to the status quo.
- [Name-based pattern matching](changed-features/pattern-matching.md): The existing undocumented Scala 2 implementation has been codified in a slightly simplified form.
- [Eta expansion](changed-features/eta-expansion.md) is now performed universally also in the absence of an expected type. The postfix `_` operator is thus made redundant. It will be deprecated and dropped after Scala 3.0.
- [Implicit Resolution](changed-features/implicit-resolution.md): The implicit resolution rules have been cleaned up to make them more useful and less surprising. Implicit scope is restricted to no longer include package prefixes.
- [Structural Types](changed-features/structural-types.md):
They now allow pluggable implementations, which greatly increases their usefulness. Some usage patterns are restricted compared to the status quo.
- [Name-based pattern matching](changed-features/pattern-matching.md):
The existing undocumented Scala 2 implementation has been codified in a slightly simplified form.
- [Automatic Eta expansion](changed-features/eta-expansion.md):
Eta expansion is now performed universally also in the absence of an expected type. The postfix `_` operator is thus made redundant. It will be deprecated and dropped after Scala 3.0.
- [Implicit Resolution](changed-features/implicit-resolution.md):
The implicit resolution rules have been cleaned up to make them more useful and less surprising. Implicit scope is restricted to no longer include package prefixes.

Most aspects of old-style implicit resolution are still available under `-source 3.0-migration`. The other changes in this list are applied unconditionally.

## New Constructs

These are additions to the language that make it more powerful or pleasant to use.

- [Enums](enums/enums.md) provide concise syntax for enumerations and [algebraic data types](enums/adts.md).
- [Parameter untupling](other-new-features/parameter-untupling.md) avoids having to use `case` for tupled parameter destructuring.
- [Dependent function types](new-types/dependent-function-types.md) generalize dependent methods to dependent function values and types.
- [Polymorphic function types](new-types/polymorphic-function-types.md) generalize polymorphic methods to polymorphic function values and types. _Current status_: There is a proposal and a merged prototype implementation, but the implementation has not been finalized (it is notably missing type inference support).
- [Kind polymorphism](other-new-features/kind-polymorphism.md) allows the definition of operators working equally on types and type constructors.
- [`@targetName` annotations](other-new-features/targetName.md) make it easier to interoperate with code written in other languages and give more flexibility for avoiding name clashes.
- [Enums](enums/enums.md) provide concise syntax for enumerations and [algebraic data types](enums/adts.md).
- [Parameter untupling](other-new-features/parameter-untupling.md) avoids having to use `case` for tupled parameter destructuring.
- [Dependent function types](new-types/dependent-function-types.md) generalize dependent methods to dependent function values and types.
- [Polymorphic function types](new-types/polymorphic-function-types.md) generalize polymorphic methods to polymorphic function values and types.
_Current status_: There is a proposal and a merged prototype implementation, but the implementation has not been finalized (it is notably missing type inference support).
- [Kind polymorphism](other-new-features/kind-polymorphism.md) allows the definition of operators working equally on types and type constructors.
- [`@targetName` annotations](other-new-features/targetName.md) make it easier to interoperate with code written in other languages and give more flexibility for avoiding name clashes.

## Metaprogramming

Expand All @@ -121,12 +134,16 @@ It's worth noting that macros were never included in the [Scala 2 language speci

To enable porting most uses of macros, we are experimenting with the advanced language constructs listed below. These designs are more provisional than the rest of the proposed language constructs for Scala 3.0. There might still be some changes until the final release. Stabilizing the feature set needed for metaprogramming is our first priority.

- [Match Types](new-types/match-types.md) allow computation on types.
- [Inline](metaprogramming/inline.md) provides
by itself a straightforward implementation of some simple macros and is at the same time an essential building block for the implementation of complex macros.
- [Quotes and Splices](metaprogramming/macros.md) provide a principled way to express macros and staging with a unified set of abstractions.
- [Type class derivation](contextual/derivation.md) provides an in-language implementation of the `Gen` macro in Shapeless and other foundational libraries. The new implementation is more robust, efficient and easier to use than the macro.
- [Implicit by-name parameters](contextual/by-name-context-parameters.md) provide a more robust in-language implementation of the `Lazy` macro in [Shapeless](https://github.com/milessabin/shapeless).
- [Match Types](new-types/match-types.md)
allow computation on types.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why you use line breaks here? (Also in other cases above and below)

Copy link
Contributor Author

@ShapelessCat ShapelessCat Feb 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@b-studios
I just want to separate the topic of each entry and their explanations.
The reasons I want to do this:

  1. In the future, for each entry, edit the topics and edit the explanations can be separated in git history because they are in different lines. I notice we changed the terms used to describe the topics before, and this kind of changes may happen in the future again. Change the terms used to describe the topics often doesn't affect the sentences following them. This is why I think separate them to different lines is good.
  2. These new line breaks won't show up when the markdown files are rendered to htmls. Since it won't affect the reading of the docs, I think add them looks ok.

- [Inline](metaprogramming/inline.md)
provides by itself a straightforward implementation of some simple macros and is at the same time an essential building block for the implementation of complex macros.
- [Quotes and Splices](metaprogramming/macros.md)
provide a principled way to express macros and staging with a unified set of abstractions.
- [Type class derivation](contextual/derivation.md)
provides an in-language implementation of the `Gen` macro in Shapeless and other foundational libraries. The new implementation is more robust, efficient and easier to use than the macro.
- [By-name context parameters](contextual/by-name-context-parameters.md)
provide a more robust in-language implementation of the `Lazy` macro in [Shapeless](https://github.com/milessabin/shapeless).

## See Also

Expand Down