Recommend users add a @type annotation in the config README.

Author: Julian

.devcontainer/lazyvim/lean.lua

@@ -5,6 +5,8 @@ return {
       'nvim-lua/plenary.nvim',
       'neovim/nvim-lspconfig',
     },
+    ---@module 'lean'
+    ---@type lean.Config
     opts = {
       infoview = {
         horizontal_position = 'top',

README.md

@@ -168,7 +168,14 @@ This can be configured by putting a line at the top of your `~/.config/nvim/init
 ## Full Configuration & Settings Information
 
 ```lua
-  require('lean').setup{
+  ---@module 'lean'
+  ---@type lean.Config
+  require('lean').setup {
+    -- Enable suggested mappings?
+    --
+    -- false by default, true to enable
+    mappings = false,
+
     -- Enable the Lean language server(s)?
     --
     -- false to disable, otherwise should be a table of options to pass to `leanls`
@@ -219,11 +226,6 @@ This can be configured by putting a line at the top of your `~/.config/nvim/init
       leader = '\\',
     },
 
-    -- Enable suggested mappings?
-    --
-    -- false by default, true to enable
-    mappings = false,
-
     -- Infoview support
     infoview = {
       -- Automatically open an infoview on entering a Lean buffer?