diff options
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/deprecated.txt | 10 | ||||
| -rw-r--r-- | runtime/doc/news.txt | 8 | ||||
| -rw-r--r-- | runtime/doc/pi_health.txt | 16 |
3 files changed, 19 insertions, 15 deletions
diff --git a/runtime/doc/deprecated.txt b/runtime/doc/deprecated.txt index 171d285950..3150190a8b 100644 --- a/runtime/doc/deprecated.txt +++ b/runtime/doc/deprecated.txt @@ -54,11 +54,11 @@ FUNCTIONS - *buffer_name()* Obsolete name for |bufname()|. - *buffer_number()* Obsolete name for |bufnr()|. - *file_readable()* Obsolete name for |filereadable()|. -- *health#report_error* Use Lua |vim.health.report_error()| instead. -- *health#report_info* Use Lua |vim.health.report_info()| instead. -- *health#report_ok* Use Lua |vim.health.report_ok()| instead. -- *health#report_start* Use Lua |vim.health.report_start()| instead. -- *health#report_warn* Use Lua |vim.health.report_warn()| instead. +- *health#report_error* *vim.health.report_error()* Use |vim.health.error()| instead. +- *health#report_info* *vim.health.report_info()* Use |vim.health.info()| instead. +- *health#report_ok* *vim.health.report_ok()* Use |vim.health.ok()| instead. +- *health#report_start* *vim.health.report_start()* Use |vim.health.start()| instead. +- *health#report_warn* *vim.health.report_warn()* Use |vim.health.warn()| instead. - *highlight_exists()* Obsolete name for |hlexists()|. - *highlightID()* Obsolete name for |hlID()|. - *inputdialog()* Use |input()| instead. diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index 6697b3018a..f196c3d445 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -62,7 +62,11 @@ DEPRECATIONS *news-deprecations* The following functions are now deprecated and will be removed in the next release. -• ... - +• Checkhealth functions: + - |health#report_error|, |vim.health.report_error()| Use Lua |vim.health.error()| instead. + - |health#report_info|, |vim.health.report_info()| Use Lua |vim.health.info()| instead. + - |health#report_ok|, |vim.health.report_ok()| Use Lua |vim.health.ok()| instead. + - |health#report_start|, |vim.health.report_start()| Use Lua |vim.health.start()| instead. + - |health#report_warn|, |vim.health.report_warn()| Use Lua |vim.health.warn()| instead. vim:tw=78:ts=8:sw=2:et:ft=help:norl: 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 -- ... |