docs(advanced-config): correct rust-analyzer settings instruction (#38)

mrcjkb · Oct 31, 2023 · b3061d4 · b3061d4
1 parent cee77f3
commit b3061d4
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -394,8 +394,10 @@ vim.g.rustaceanvim = {
     on_attach = function(client, bufnr)
       -- you can also put keymaps in here
     end,
-    -- rust-analyzer language server configuration
-    ['rust-analyzer'] = {
+    settings = {
+      -- rust-analyzer language server configuration
+      ['rust-analyzer'] = {
+      },
     },
   },
   -- DAP configuration

diff --git a/doc/rustaceanvim.txt b/doc/rustaceanvim.txt
@@ -51,7 +51,8 @@ To configure rustaceanvim, set the variable `vim.g.rustaceanvim`,
 which is a `RustaceanOpts` table, in your neovim configuration.
 
 Example:
->
+
+>lua
 ---@type RustaceanOpts
 vim.g.rustaceanvim = {
    ---@type RustaceanToolsOpts
@@ -63,8 +64,10 @@ vim.g.rustaceanvim = {
      on_attach = function(client, bufnr)
        -- Set keybindings, etc. here.
      end,
-     ['rust-analyzer'] = {
-       -- ...
+     settings = {
+       -- rust-analyzer language server configuration
+       ['rust-analyzer'] = {
+       },
      },
      -- ...
    },
@@ -75,7 +78,7 @@ vim.g.rustaceanvim = {
  }
 <
 
-Note: `vim.g.rustaceanvim` can also be a function that returns a 'RustaceanOpts' table.
+Note: `vim.g.rustaceanvim` can also be a function that returns a `RustaceanOpts` table.
 
 
 RustaceanOpts                                                    *RustaceanOpts*

diff --git a/lua/rustaceanvim/config/init.lua b/lua/rustaceanvim/config/init.lua
@@ -9,7 +9,8 @@
 ---which is a `RustaceanOpts` table, in your neovim configuration.
 ---
 ---Example:
---->
+---
+--->lua
 ------@type RustaceanOpts
 ---vim.g.rustaceanvim = {
 ---   ---@type RustaceanToolsOpts
@@ -21,8 +22,10 @@
 ---     on_attach = function(client, bufnr)
 ---       -- Set keybindings, etc. here.
 ---     end,
----     ['rust-analyzer'] = {
----       -- ...
+---     settings = {
+---       -- rust-analyzer language server configuration
+---       ['rust-analyzer'] = {
+---       },
 ---     },
 ---     -- ...
 ---   },
@@ -33,7 +36,7 @@
 --- }
 ---<
 ---
----Note: `vim.g.rustaceanvim` can also be a function that returns a 'RustaceanOpts' table.
+---Note: `vim.g.rustaceanvim` can also be a function that returns a `RustaceanOpts` table.
 ---
 ---@brief ]]