diff options
Diffstat (limited to 'runtime/doc/pi_health.txt')
| -rw-r--r-- | runtime/doc/pi_health.txt | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/runtime/doc/pi_health.txt b/runtime/doc/pi_health.txt index a0e06a7d37..266c021ecc 100644 --- a/runtime/doc/pi_health.txt +++ b/runtime/doc/pi_health.txt @@ -52,22 +52,22 @@ Functions *health-functions* *vim.health* The Lua "health" module can be used to create new healthchecks. To get started see |health-dev|. -vim.health.report_start({name}) *vim.health.report_start()* +vim.health.start({name}) *vim.health.start()* Starts a new report. Most plugins should call this only once, but if you want different sections to appear in your report, call this once per section. -vim.health.report_info({msg}) *vim.health.report_info()* +vim.health.info({msg}) *vim.health.info()* Reports an informational message. -vim.health.report_ok({msg}) *vim.health.report_ok()* +vim.health.ok({msg}) *vim.health.ok()* Reports a "success" message. -vim.health.report_warn({msg} [, {advice}]) *vim.health.report_warn()* +vim.health.warn({msg} [, {advice}]) *vim.health.warn()* Reports a warning. {advice} is an optional list of suggestions to present to the user. -vim.health.report_error({msg} [, {advice}]) *vim.health.report_error()* +vim.health.error({msg} [, {advice}]) *vim.health.error()* Reports an error. {advice} is an optional list of suggestions to present to the user. @@ -105,12 +105,12 @@ with your plugin name: > local M = {} M.check = function() - vim.health.report_start("foo report") + vim.health.start("foo report") -- make sure setup function parameters are ok if check_setup() then - vim.health.report_ok("Setup is correct") + vim.health.ok("Setup is correct") else - vim.health.report_error("Setup is incorrect") + vim.health.error("Setup is incorrect") end -- do some more checking -- ... |