Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bjaglin committed Sep 27, 2024
1 parent 5f262d8 commit fe41df2
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/rules/ExplicitResultTypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ id: ExplicitResultTypes
title: ExplicitResultTypes
---

This rewrite inserts type annotations for inferred public members. Only compatible with
scala 2.12 & 2.13.
This rewrite inserts type annotations for inferred public members.

Example:

Expand Down Expand Up @@ -35,6 +34,9 @@ This rule has several known limitations, which are most likely fixable with some
effort. At the time of this writing, there are no short-term plans to address
these issues however.

Scala 3 support is recent and therefore not widely tested. Expect annotations
to be be less precise than the ones added to sources compiled with Scala 2.x.

### Imports ordering

The rewrite inserts imports at the bottom of the global import list. Users are
Expand All @@ -43,8 +45,8 @@ expected to organize the imports according to the conventions of their codebase.
For example, the rewrite may produce the following diff.

```diff
import java.io.File
import scala.collection.mutable
import java.io.File
import scala.collection.mutable
+ import java.util.UUID
```

Expand Down

0 comments on commit fe41df2

Please sign in to comment.