docs: cleanup

- brief should live at the top of each file
- fix indentation for some docs

1 files changed, 25 insertions, 24 deletions

diff --git a/lsp/julials.lua b/lsp/julials.lua
index 0dd8c6b3..17565a7c 100644
--- a/lsp/julials.lua
+++ b/lsp/julials.lua
@@ -1,3 +1,28 @@
+---@brief
+---
+--- https://github.com/julia-vscode/julia-vscode
+---
+--- LanguageServer.jl can be installed with `julia` and `Pkg`:
+--- ```sh
+--- julia --project=~/.julia/environments/nvim-lspconfig -e 'using Pkg; Pkg.add("LanguageServer")'
+--- ```
+--- where `~/.julia/environments/nvim-lspconfig` is the location where
+--- the default configuration expects LanguageServer.jl to be installed.
+---
+--- To update an existing install, use the following command:
+--- ```sh
+--- julia --project=~/.julia/environments/nvim-lspconfig -e 'using Pkg; Pkg.update()'
+--- ```
+---
+--- Note: In order to have LanguageServer.jl pick up installed packages or dependencies in a
+--- Julia project, you must make sure that the project is instantiated:
+--- ```sh
+--- julia --project=/path/to/my/project -e 'using Pkg; Pkg.instantiate()'
+--- ```
+---
+--- Note: The julia programming language searches for global environments within the `environments/`
+--- folder of `$JULIA_DEPOT_PATH` entries. By default this simply `~/.julia/environments`
+
 local root_files = { 'Project.toml', 'JuliaProject.toml' }
 
 local function activate_env(path)
@@ -91,30 +116,6 @@ local cmd = {
   ]],
 }
 
----@brief
----
--- https://github.com/julia-vscode/julia-vscode
---
--- LanguageServer.jl can be installed with `julia` and `Pkg`:
--- ```sh
--- julia --project=~/.julia/environments/nvim-lspconfig -e 'using Pkg; Pkg.add("LanguageServer")'
--- ```
--- where `~/.julia/environments/nvim-lspconfig` is the location where
--- the default configuration expects LanguageServer.jl to be installed.
---
--- To update an existing install, use the following command:
--- ```sh
--- julia --project=~/.julia/environments/nvim-lspconfig -e 'using Pkg; Pkg.update()'
--- ```
---
--- Note: In order to have LanguageServer.jl pick up installed packages or dependencies in a
--- Julia project, you must make sure that the project is instantiated:
--- ```sh
--- julia --project=/path/to/my/project -e 'using Pkg; Pkg.instantiate()'
--- ```
---
--- Note: The julia programming language searches for global environments within the `environments/`
--- folder of `$JULIA_DEPOT_PATH` entries. By default this simply `~/.julia/environments`
 return {
   cmd = cmd,
   filetypes = { 'julia' },