Skip to content

Commit a440a23

Browse files
committed
Make purpose of the options clearer in the internal docs
1 parent eb8a315 commit a440a23

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/_docs/internals/best-effort-compilation.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ It is composed of two experimental compiler options:
1111
* `-Ywith-best-effort-tasty` allows to read Best Effort TASTy files, and if such file is read from the classpath then
1212
limits compilation to the frontend phases
1313

14+
IMPORTANT: These options are meant to by used by an IDE and should never be used on the user side, in the project definition.
15+
This is why they are hidden behind a private `-Y` option specifier.
16+
1417
This feature aims to force through to the typer phase regardless of errors, and then serialize tasty-like files
1518
obtained from the error trees into the best effort directory (`META-INF/best-effort`) and also serialize semanticdb as normal.
1619

0 commit comments

Comments
 (0)