Skip to content

Commit 67bf90a

Browse files
committed
Updated docs per reviwer comments
1 parent ba24710 commit 67bf90a

File tree

3 files changed

+6
-12
lines changed

3 files changed

+6
-12
lines changed

docs/content/getting-started/CLI.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,13 @@ index: 3
88

99
## Example Command
1010

11-
When running the CLI tool from the command line, the bare minimum you need to provide is the path to the project file(s) you want to analyze.
12-
13-
```shell
14-
dotnet fsharp-analyzers --project ./YourProject.fsproj
15-
```
16-
17-
An optional argument you may need to provide is `--analyzers-path`. This is the path to the directory containing the analyzer DLLs.
11+
When running the CLI tool from the command line (and after installing analyzers), the minimum console arguments you need to provide is the path to the project file(s) you want to analyze.
1812

1913
```shell
2014
dotnet fsharp-analyzers --project ./YourProject.fsproj --analyzers-path ./path/to/analyzers/directory
2115
```
2216

23-
⚠️ If you don't provide this argument, it will default to `packages/analyzers`.
17+
⚠️ If you don't provide the `--analyzers-path` argument, it will default to `packages/analyzers`. If you are using Paket with a group called `analyzers`, this default path should work for you.
2418

2519
## Viewing Additional Commands
2620

docs/content/getting-started/Configuring for IDE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ index: 2
88

99
## Visual Studio Code
1010

11-
In order to configure analyzers for VSCode, you will need to update your project's `.vscode/settings.json` file or your user settings. You should only need the following settings:
11+
In order to configure analyzers for VSCode, you will need to update your project's `.vscode/settings.json` file or your user settings. You should need the settings shown below.
1212

1313
```json
1414
{
1515
"FSharp.enableAnalyzers": true,
16-
"FSharp.analyzersPath": ["packages/analyzers"]
16+
"FSharp.analyzersPath": ["path/to/analyzers/directory"]
1717
}
1818
```
1919

20-
📓 Note: The path in `FSharp.analyzersPath` above is currently pointing to the path we set up in the Paket example on the [installation page]({{fsdocs-previous-page-link}}).
20+
📓 Note: Issue created [here](https://github.com/ionide/FsAutoComplete/issues/1350) regarding analyzers & SDK mismatches in the logs
2121

2222
After saving your new settings, make sure to restart VSCode. Once VSCode restarts, you should be able to test and see if the analyzers are working by opening a F# file in your workspace and entering the following code
2323

docs/content/getting-started/Installing Analyzers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ index: 1
1010
A dotnet CLI tool, called [fsharp-analyzers](https://github.com/ionide/FSharp.Analyzers.SDK/), is used to run analyzers outside the context of an IDE. Add it to your tool-manifest with:
1111

1212
```shell
13-
dotnet tool install fsharp-analyzers
13+
dotnet tool install fsharp-analyzers --create-manifest-if-needed
1414
```
1515

1616
## Installing Analyzers

0 commit comments

Comments
 (0)