Skip to content

Commit

Permalink
docs(vimdoc): add FloatWinConfig docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrcjkb committed May 10, 2024
1 parent be266f0 commit 187ba89
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
11 changes: 10 additions & 1 deletion doc/rustaceanvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ RustaceanToolsOpts *RustaceanToolsOpts*
{reload_workspace_from_cargo_toml?} (boolean) Automatically call `RustReloadWorkspace` when writing to a Cargo.toml file
{hover_actions?} (RustaceanHoverActionsOpts) Options for hover actions
{code_actions?} (RustaceanCodeActionOpts) Options for code actions
{float_win_config?} (table) Options applied to floating windows. See |api-win_config|.
{float_win_config?} (FloatWinConfig) Options applied to floating windows. See |api-win_config|.
{create_graph?} (RustaceanCrateGraphConfig) Options for showing the crate graph based on graphviz and the dot
{open_url?} (fun(url:string):nil) If set, overrides how to open URLs
{rustc?} (RustcOpts) Options for `rustc`
Expand All @@ -168,6 +168,15 @@ RustaceanExecutorOpts *RustaceanExecutorOpts*
{bufnr?} (integer) The buffer from which the executor was invoked.


FloatWinConfig *FloatWinConfig*

Fields: ~
{open_split} ("horizontal"|"vertical")

See: ~
|vim.lsp.util.open_floating_preview.Opts|


executor_alias *executor_alias*

Type: ~
Expand Down
1 change: 1 addition & 0 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@
plugins = luarc-plugins;
disabled-diagnostics = [
"undefined-doc-name"
"undefined-doc-class"
"redundant-parameter"
"invisible"
];
Expand Down
6 changes: 5 additions & 1 deletion lua/rustaceanvim/config/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ vim.g.rustaceanvim = vim.g.rustaceanvim
---@field reload_workspace_from_cargo_toml? boolean Automatically call `RustReloadWorkspace` when writing to a Cargo.toml file
---@field hover_actions? RustaceanHoverActionsOpts Options for hover actions
---@field code_actions? RustaceanCodeActionOpts Options for code actions
---@field float_win_config? table Options applied to floating windows. See |api-win_config|.
---@field float_win_config? FloatWinConfig Options applied to floating windows. See |api-win_config|.
---@field create_graph? RustaceanCrateGraphConfig Options for showing the crate graph based on graphviz and the dot
---@field open_url? fun(url:string):nil If set, overrides how to open URLs
---@field rustc? RustcOpts Options for `rustc`
Expand All @@ -76,6 +76,10 @@ vim.g.rustaceanvim = vim.g.rustaceanvim
---@class RustaceanExecutorOpts
---@field bufnr? integer The buffer from which the executor was invoked.

---@class FloatWinConfig
---@field open_split 'horizontal' | 'vertical'
---@see vim.lsp.util.open_floating_preview.Opts

---@alias executor_alias 'termopen' | 'quickfix' | 'toggleterm' | 'vimux' | 'neotest'

---@alias test_executor_alias executor_alias | 'background'
Expand Down

0 comments on commit 187ba89

Please sign in to comment.