modules/autocmd: rename autoCmd.*.description to desc

This commit is contained in:
Gaetan Lepage 2023-09-29 09:07:24 +02:00 committed by Gaétan Lepage
parent 9e448b7ff0
commit 6b4911e67f

View file

@ -17,6 +17,13 @@ with lib; let
}; };
autoCmdOption = types.submodule { autoCmdOption = types.submodule {
imports = [
(
# TODO remove this deprecation warning in December 2023
mkRenamedOptionModule
["description"] ["desc"]
)
];
options = { options = {
event = helpers.mkNullOrOption (types.either types.str (types.listOf types.str)) '' event = helpers.mkNullOrOption (types.either types.str (types.listOf types.str)) ''
The event or events to register this autocommand. The event or events to register this autocommand.
@ -35,7 +42,9 @@ with lib; let
Cannot be used with `pattern`. Cannot be used with `pattern`.
''; '';
description = helpers.mkNullOrOption types.str "A textual description of this autocommand."; desc = helpers.mkNullOrOption types.str ''
A textual description of this autocommand.
'';
callback = helpers.mkNullOrOption (types.either types.str helpers.rawType) '' callback = helpers.mkNullOrOption (types.either types.str helpers.rawType) ''
A function or a string. A function or a string.