From f8b5cbe6312b568def1f91d747e2cdb8984fdf2e Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Fri, 18 Apr 2025 17:44:38 +0200
Subject: docs: cleanup

- brief should live at the top of each file
- fix indentation for some docs
---
 lsp/atlas.lua | 100 +++++++++++++++++++++++++++++-----------------------------
 1 file changed, 50 insertions(+), 50 deletions(-)

(limited to 'lsp/atlas.lua')

diff --git a/lsp/atlas.lua b/lsp/atlas.lua
index aa85d9af..62049425 100644
--- a/lsp/atlas.lua
+++ b/lsp/atlas.lua
@@ -1,55 +1,55 @@
 ---@brief
 ---
--- https://github.com/ariga/atlas
---
--- Language server for Atlas config and scheme files.
---
--- You may also need to configure the filetype for *.hcl files:
---
--- `autocmd BufNewFile,BufRead atlas.hcl set filetype=atlas-config`
--- `autocmd BufNewFile,BufRead *.my.hcl set filetype=atlas-schema-mysql`
--- `autocmd BufNewFile,BufRead *.pg.hcl set filetype=atlas-schema-postgresql`
--- `autocmd BufNewFile,BufRead *.lt.hcl set filetype=atlas-schema-sqlite`
--- `autocmd BufNewFile,BufRead *.ch.hcl set filetype=atlas-schema-clickhouse`
--- `autocmd BufNewFile,BufRead *.ms.hcl set filetype=atlas-schema-mssql`
--- `autocmd BufNewFile,BufRead *.rs.hcl set filetype=atlas-schema-redshift`
--- `autocmd BufNewFile,BufRead *.test.hcl set filetype=atlas-test`
--- `autocmd BufNewFile,BufRead *.plan.hcl set filetype=atlas-plan`
---
--- or
---
--- ```lua
--- vim.filetype.add({
---   filename = {
---     ['atlas.hcl'] = 'atlas-config',
---   },
---   pattern = {
---     ['.*/*.my.hcl'] = 'atlas-schema-mysql',
---     ['.*/*.pg.hcl'] = 'atlas-schema-postgresql',
---     ['.*/*.lt.hcl'] = 'atlas-schema-sqlite',
---     ['.*/*.ch.hcl'] = 'atlas-schema-clickhouse',
---     ['.*/*.ms.hcl'] = 'atlas-schema-mssql',
---     ['.*/*.rs.hcl'] = 'atlas-schema-redshift',
---     ['.*/*.test.hcl'] = 'atlas-test',
---     ['.*/*.plan.hcl'] = 'atlas-plan',
---   },
--- })
--- ```
---
--- Optionally, tell treesitter to treat Atlas filetypes as HCL for better syntax highlighting:
---
--- ```lua
--- vim.treesitter.language.register('hcl', 'atlas-config')
--- vim.treesitter.language.register('hcl', 'atlas-schema-mysql')
--- vim.treesitter.language.register('hcl', 'atlas-schema-postgresql')
--- vim.treesitter.language.register('hcl', 'atlas-schema-sqlite')
--- vim.treesitter.language.register('hcl', 'atlas-schema-clickhouse')
--- vim.treesitter.language.register('hcl', 'atlas-schema-mssql')
--- vim.treesitter.language.register('hcl', 'atlas-schema-redshift')
--- vim.treesitter.language.register('hcl', 'atlas-test')
--- vim.treesitter.language.register('hcl', 'atlas-plan')
--- ```
---
+--- https://github.com/ariga/atlas
+---
+--- Language server for Atlas config and scheme files.
+---
+--- You may also need to configure the filetype for *.hcl files:
+---
+--- `autocmd BufNewFile,BufRead atlas.hcl set filetype=atlas-config`
+--- `autocmd BufNewFile,BufRead *.my.hcl set filetype=atlas-schema-mysql`
+--- `autocmd BufNewFile,BufRead *.pg.hcl set filetype=atlas-schema-postgresql`
+--- `autocmd BufNewFile,BufRead *.lt.hcl set filetype=atlas-schema-sqlite`
+--- `autocmd BufNewFile,BufRead *.ch.hcl set filetype=atlas-schema-clickhouse`
+--- `autocmd BufNewFile,BufRead *.ms.hcl set filetype=atlas-schema-mssql`
+--- `autocmd BufNewFile,BufRead *.rs.hcl set filetype=atlas-schema-redshift`
+--- `autocmd BufNewFile,BufRead *.test.hcl set filetype=atlas-test`
+--- `autocmd BufNewFile,BufRead *.plan.hcl set filetype=atlas-plan`
+---
+--- or
+---
+--- ```lua
+--- vim.filetype.add({
+---   filename = {
+---     ['atlas.hcl'] = 'atlas-config',
+---   },
+---   pattern = {
+---     ['.*/*.my.hcl'] = 'atlas-schema-mysql',
+---     ['.*/*.pg.hcl'] = 'atlas-schema-postgresql',
+---     ['.*/*.lt.hcl'] = 'atlas-schema-sqlite',
+---     ['.*/*.ch.hcl'] = 'atlas-schema-clickhouse',
+---     ['.*/*.ms.hcl'] = 'atlas-schema-mssql',
+---     ['.*/*.rs.hcl'] = 'atlas-schema-redshift',
+---     ['.*/*.test.hcl'] = 'atlas-test',
+---     ['.*/*.plan.hcl'] = 'atlas-plan',
+---   },
+--- })
+--- ```
+---
+--- Optionally, tell tr