diff --git a/runtime/doc/ui.txt b/runtime/doc/api-ui-events.txt similarity index 99% rename from runtime/doc/ui.txt rename to runtime/doc/api-ui-events.txt index 6f3a60902c..c221521af8 100644 --- a/runtime/doc/ui.txt +++ b/runtime/doc/api-ui-events.txt @@ -1,10 +1,13 @@ -*ui.txt* Nvim +*api-ui-events.txt* Nvim NVIM REFERENCE MANUAL -Nvim UI protocol *UI* *ui* +Nvim UI protocol *UI* *ui* *api-ui-events* + +This document describes the UI protocol. See |gui| and |tui| for user-facing +UI components and features. Type |gO| to see the table of contents. diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 6e734c1645..470722a959 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -231,21 +231,19 @@ As Nvim evolves the API may change in compliance with this CONTRACT: - New functions and events may be added. - Any such extensions are OPTIONAL: old clients may ignore them. -- Function signatures will NOT CHANGE (after release), except as follows: - - Functions introduced in the development (unreleased) version MAY CHANGE. - (Clients can dynamically check `api_prerelease`, etc. |api-metadata|) - - New items may be ADDED to map/list parameters/results of functions and - events. - - Any such new items are OPTIONAL: old clients may ignore them. - - Existing items will not be removed (after release). - - Return type may change from void to non-void. Old clients MAY ignore the +- New functions MAY CHANGE before release. Clients can dynamically check + `api_prerelease`, |api-metadata|. +- Function signatures will NOT CHANGE after release, except as follows: + - Map/list parameters/results may be EXTENDED (new fields may be added). + - Such new fields are OPTIONAL: old clients MAY ignore them. + - Existing fields will not be removed. + - Return type MAY CHANGE from void to non-void. Old clients MAY ignore the new return value. - - An `opts` parameter may be added, which is not required in the request. - - Unlimited optional parameters may be added following an `opts` - parameter. + - An optional `opts` parameter may be ADDED. + - Optional parameters may be ADDED following an `opts` parameter. - Event parameters will not be removed or reordered (after release). - Events may be EXTENDED: new parameters may be added. -- Deprecated functions will not be removed until Nvim version 2.0 +- Deprecated functions will not be removed until Nvim 2.0. "Private" interfaces are NOT covered by this contract: diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt index 9091199daf..5482dabc40 100644 --- a/runtime/doc/autocmd.txt +++ b/runtime/doc/autocmd.txt @@ -73,7 +73,8 @@ Or use `:execute`: > Note that special characters (e.g., "%", "") in the ":autocmd" arguments are not expanded when the autocommand is defined. These will be expanded when the Event is recognized, and the {cmd} is executed. The only -exception is that "" is expanded when the autocmd is defined. Example: +exception is that "" (unlike "