From 4b3be56a03695fa14ed28d6ded4cb338cbb99249 Mon Sep 17 00:00:00 2001 From: Peter Aronoff Date: Thu, 4 Jul 2024 13:15:35 -0400 Subject: fix(diagnostic): make docs agree with code (#29561) Problem: the code and docs for vim.diagnostic.JumpOpts.float send mixed signals about what the default should be. When the option is first set, in the global_diagnostic_options table, the comment clearly says that the default is false. Later in the code, in goto_diagnostic, there's a line that sets the default to true if no default is present. Finally, the docs say that the default is true. Solution: Change the docs to reflect the new default of false and fix the goto_diagnostic function. --- runtime/doc/diagnostic.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'runtime/doc') diff --git a/runtime/doc/diagnostic.txt b/runtime/doc/diagnostic.txt index 05af2eddc3..444829c325 100644 --- a/runtime/doc/diagnostic.txt +++ b/runtime/doc/diagnostic.txt @@ -401,7 +401,7 @@ Lua module: vim.diagnostic *diagnostic-api* file or not. Similar to 'wrapscan'. • {severity}? (`vim.diagnostic.SeverityFilter`) See |diagnostic-severity|. - • {float}? (`boolean|vim.diagnostic.Opts.Float`, default: `true`) + • {float}? (`boolean|vim.diagnostic.Opts.Float`, default: `false`) If `true`, call |vim.diagnostic.open_float()| after moving. If a table, pass the table as the {opts} parameter to |vim.diagnostic.open_float()|. Unless -- cgit