Skip to content

Derivation documentation: use inline def derived so that derives is employed #16919

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

Closed
wants to merge 2 commits into from
Closed

Derivation documentation: use inline def derived so that derives is employed #16919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b450b4a
Derivation documentation: use `inline def derived` so that `derives` …
sideeffffect Feb 14, 2023
de0c5a3
Update derivation-macro.md
sideeffffect Feb 15, 2023
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/_docs/reference/contextual/derivation-macro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ given derived[T: Type](using Quotes): Expr[Eq[T]]
and for comparison reasons we give the same signature we had with `inline`:

```scala
inline given derived[T](using Mirror.Of[T]): Eq[T] = ???
inline def derived[T](using Mirror.Of[T]): Eq[T] = ???
```

Note, that since a type is used in a subsequent stage it will need to be lifted
Expand Down
2 changes: 1 addition & 1 deletion docs/_docs/reference/contextual/derivation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ object Eq:
case ((x, y), elem) => check(elem)(x, y)
}

inline given derived[T](using m: Mirror.Of[T]): Eq[T] =
inline def derived[T](using m: Mirror.Of[T]): Eq[T] =
Copy link
Contributor

@nicolasstucki nicolasstucki Feb 15, 2023

Choose a reason for hiding this comment

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

I believe there is a test case with this example that also needs to be updated.
Copy link
Member

@bishabosha bishabosha Feb 15, 2023

Choose a reason for hiding this comment

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

a cursory search of "given derived" reveals quite a lot of instances, including in the docs/_docs/reference/contextual/derivation-macro.md document, which is derivation using macro quotes and splices instead of inline match
lazy val elemInstances = summonAll[m.MirroredElemTypes]
inline m match
case s: Mirror.SumOf[T] => eqSum(s, elemInstances)
Expand Down