docs: cleanup

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

1 files changed, 31 insertions, 31 deletions

diff --git a/lsp/terraformls.lua b/lsp/terraformls.lua
index 64fb46ac..7b8c9d7c 100644
--- a/lsp/terraformls.lua
+++ b/lsp/terraformls.lua
@@ -1,36 +1,36 @@
 ---@brief
 ---
--- https://github.com/hashicorp/terraform-ls
---
--- Terraform language server
--- Download a released binary from https://github.com/hashicorp/terraform-ls/releases.
---
--- From https://github.com/hashicorp/terraform-ls#terraform-ls-vs-terraform-lsp:
---
--- Both HashiCorp and the maintainer of terraform-lsp expressed interest in
--- collaborating on a language server and are working towards a _long-term_
--- goal of a single stable and feature-complete implementation.
---
--- For the time being both projects continue to exist, giving users the
--- choice:
---
--- - `terraform-ls` providing
---   - overall stability (by relying only on public APIs)
---   - compatibility with any provider and any Terraform >=0.12.0 currently
---     less features
---   - due to project being younger and relying on public APIs which may
---     not offer the same functionality yet
---
--- - `terraform-lsp` providing
---   - currently more features
---   - compatibility with a single particular Terraform (0.12.20 at time of writing)
---     - configs designed for other 0.12 versions may work, but interpretation may be inaccurate
---   - less stability (due to reliance on Terraform's own internal packages)
---
--- Note, that the `settings` configuration option uses the `workspace/didChangeConfiguration` event,
--- [which is not supported by terraform-ls](https://github.com/hashicorp/terraform-ls/blob/main/docs/features.md).
--- Instead you should use `init_options` which passes the settings as part of the LSP initialize call
--- [as is required by terraform-ls](https://github.com/hashicorp/terraform-ls/blob/main/docs/SETTINGS.md#how-to-pass-settings).
+--- https://github.com/hashicorp/terraform-ls
+---
+--- Terraform language server
+--- Download a released binary from https://github.com/hashicorp/terraform-ls/releases.
+---
+--- From https://github.com/hashicorp/terraform-ls#terraform-ls-vs-terraform-lsp:
+---
+--- Both HashiCorp and the maintainer of terraform-lsp expressed interest in
+--- collaborating on a language server and are working towards a _long-term_
+--- goal of a single stable and feature-complete implementation.
+---
+--- For the time being both projects continue to exist, giving users the
+--- choice:
+---
+--- - `terraform-ls` providing
+---   - overall stability (by relying only on public APIs)
+---   - compatibility with any provider and any Terraform >=0.12.0 currently
+---     less features
+---   - due to project being younger and relying on public APIs which may
+---     not offer the same functionality yet
+---
+--- - `terraform-lsp` providing
+---   - currently more features
+---   - compatibility with a single particular Terraform (0.12.20 at time of writing)
+---     - configs designed for other 0.12 versions may work, but interpretation may be inaccurate
+---   - less stability (due to reliance on Terraform's own internal packages)
+---
+--- Note, that the `settings` configuration option uses the `workspace/didChangeConfiguration` event,
+--- [which is not supported by terraform-ls](https://github.com/hashicorp/terraform-ls/blob/main/docs/features.md).
+--- Instead you should use `init_options` which passes the settings as part of the LSP initialize call
+--- [as is required by terraform-ls](https://github.com/hashicorp/terraform-ls/blob/main/docs/SETTINGS.md#how-to-pass-settings).
 return {
   cmd = { 'terraform-ls', 'serve' },
   filetypes = { 'terraform', 'terraform-vars' },