Skip to content

Commit 3943fa2

Browse files
committed
Update outdated pieces of docs
1 parent b1aedf9 commit 3943fa2

File tree

3 files changed

+4
-9
lines changed

3 files changed

+4
-9
lines changed

website/docs/guides/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Parameters on the command line take precedence over parameters in sources.
1111
That way, you can quickly override parameters from the command line.
1212

1313
:::warning
14-
The configuration options and syntax in `.scala` files is likely to evolve in the future.
14+
The configuration options and syntax in `.scala` (and `.sc`) files is likely to evolve in the future.
1515
:::
1616

1717
## Command-line

website/docs/guides/dependencies.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ scala-cli compile Hello.scala \
1313

1414
Note that `--dependency` is only meant as a convenience.
1515
You should favor adding dependencies in the sources themselves via [using directives](./guides/configuration.md#special-imports).
16-
However, `--dependency` CLI option takes precedence over `using` directives, so it can be used to override the `using` directive, such as when you want to work with a different dependency version.
16+
<!-- TODO #344
17+
However, `--dependency` CLI option takes precedence over `using` directives, so it can be used to override the `using` directive, such as when you want to work with a different dependency version. -->
1718

1819
You can also add repositories on the command-line, via `--repository`:
1920
```bash

website/docs/guides/ide.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,19 +46,13 @@ In an ideal world we would replace the rest of this guide with something along t
4646

4747
Once Metals picks up the project structure that’s created by Scala CLI, basic features like navigation, diagnostics, and code completion should work.
4848

49-
Here are a few notes related to Metals support:
5049

51-
- The current release of Metals (0.10.8) is not able to pick up changes in the build structure automatically, including the addition of new source files.
52-
In order for Metals to pick up new files or changes in the build structure, you need to trigger the Metals 'Restart build server' command.
53-
- At this moment, main classes and tests are not recognized in Metals.
54-
- Generally, mainly due to problems with keeping the project structure up to date, Metals can assist with writing code while using Scala CLI, *but*, it cannot be considered the “source of truth,” and we recommend falling back to the command line in such cases.
5550

56-
That last line means that, at this moment, Scala CLI should be considered the correct and accurate source of project configuration information.
5751

5852
## IntelliJ
5953

6054
Here are a few notes related to IntelliJ support:
6155

6256
- The most significant problem with IntelliJ is that it requires sources to be placed within a directory. Therefore, if you use IntelliJ, we strongly suggest that you place your sources in a directory (like `src`).
6357
- IntelliJ currently does not automatically pick up changes in the project structure, so any change in dependencies, compiler options, etc., need to be manually reloaded.
64-
- Similarly to Metals, we currently don’t advise using IntelliJ as a source of truth, and we recommend falling back to command line in such cases.
58+
- We currently don’t advise using IntelliJ as a source of truth, and we recommend falling back to command line in such cases.

0 commit comments

Comments
 (0)