Skip to content

Fix minor typos in derivation docs #7074

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 1 commit into from
Aug 21, 2019
Merged

Fix minor typos in derivation docs #7074

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions docs/docs/reference/contextual/derivation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ enum Tree[T] derives Eq, Ordering, Show {
}
```

The `derives` clause generates the follwoing given instances for the `Eq`, `Ordering` and `Show` type classes in the
The `derives` clause generates the following given instances for the `Eq`, `Ordering` and `Show` type classes in the
companion object of `Tree`,

```scala
Expand Down Expand Up @@ -47,7 +47,7 @@ derivation support.
type MirroredType

/** the type of the elements of the mirrored type */
type MirroedElemTypes
type MirroredElemTypes

/** The mirrored *-type */
type MirroredMonoType
Expand All @@ -74,8 +74,8 @@ derivation support.
}
```

Product types (ie. case classes and objects, and enum cases) have mirrors which are subtypes of `Mirror.Product`. Sum
types (ie. sealed class or traits with product children, and enums) have mirrors which are subtypes of `Mirror.Sum`.
Product types (i.e. case classes and objects, and enum cases) have mirrors which are subtypes of `Mirror.Product`. Sum
types (i.e. sealed class or traits with product children, and enums) have mirrors which are subtypes of `Mirror.Sum`.

For the `Tree` ADT from above the following `Mirror` instances will be automatically provided by the compiler,

Expand Down Expand Up @@ -146,8 +146,8 @@ That is, the `derived` method takes a given parameter of (some subtype of) type
the deriving type `T`, and computes the type class implementation according to that shape. This is all that the
provider of an ADT with a `derives` clause has to know about the derivation of a type class instance.

Note that `derived` methods may have given `Mirror` arguments indirectly (eg. by having a given argument which in turn
has a given `Mirror`, or not at all (eg. they might use some completely different user-provided mechanism, for
Note that `derived` methods may have given `Mirror` arguments indirectly (e.g. by having a given argument which in turn
has a given `Mirror`, or not at all (e.g. they might use some completely different user-provided mechanism, for
instance using Dotty macros or runtime reflection). We expect that (direct or indirect) `Mirror` based implementations
will be the most common and that is what this document emphasises.

Expand Down