Skip to content

Commit 25ad8ad

Browse files
authored
Merge pull request #60 from tpgillam/patch-1
Clarify necessary location of .JuliaFormatter.toml
2 parents e1c45ba + 5f310ba commit 25ad8ad

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/src/userguide/formatter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Formatting Code
22
Code formatting is powered by [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl). Both the `Format Document` command (`Ctrl-Shift-I`) and `Format Selection` (`Ctrl-K Ctrl-F`) are supported.
33

4-
The default formatting is fairly conservative and unintrusive, but you can customise it with a `.JuliaFormatter.toml` in your workspace. Check out the [relevant documentation here](https://domluna.github.io/JuliaFormatter.jl/stable/).
4+
The default formatting is fairly conservative and unintrusive, but you can customise it with a `.JuliaFormatter.toml` in your workspace. Check out the [relevant documentation here](https://domluna.github.io/JuliaFormatter.jl/stable/). **Note:** unlike the [standard search rules for JuliaFormatter.jl](https://domluna.github.io/JuliaFormatter.jl/stable/config/#Configuration-File), VSCode will only check for `.JuliaFormatter.toml` files within the workspace.
55

66
Formatting helps to keep code readable by automatically aligning indentations and spaces.
77

0 commit comments

Comments
 (0)