mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 00:25:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: clean up descriptions (#1061)

Browse source
This commit is contained in:
Gabriel Arazas 2024-02-11 12:51:34 +00:00 • committed by GitHub
parent 40ede678d2
commit 0b5800a2a2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 27 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

16
modules/commands.nix
View file

@ -9,7 +9,7 @@ with lib; let
options = {
command = mkOption {
type = types.str;
description = "The command to run";
description = "The command to run.";
};
nargs = helpers.mkNullOrOption (types.enum ["0" "1" "*" "?" "+"]) ''
@ -27,12 +27,12 @@ with lib; let
addr = helpers.mkNullOrOption types.str ''
Whether special characters relate to other things, see :h command-addr.
'';
bang = helpers.defaultNullOpts.mkBool false "Whether this command can take a bang (!)";
bar = helpers.defaultNullOpts.mkBool false "Whether this command can be followed by a \"|\" and another command";
register = helpers.defaultNullOpts.mkBool false "The first argument to the command can be an optional register";
keepscript = helpers.defaultNullOpts.mkBool false "Do not use the location of where the user command was defined for verbose messages, use the location of where the command was invoked";
force = helpers.defaultNullOpts.mkBool false "Overwrite an existing user command";
desc = helpers.defaultNullOpts.mkStr "" "A description of the command";
bang = helpers.defaultNullOpts.mkBool false "Whether this command can take a bang (!).";
bar = helpers.defaultNullOpts.mkBool false "Whether this command can be followed by a \"|\" and another command.";
register = helpers.defaultNullOpts.mkBool false "The first argument to the command can be an optional register.";
keepscript = helpers.defaultNullOpts.mkBool false "Do not use the location of where the user command was defined for verbose messages, use the location of where the command was invoked.";
force = helpers.defaultNullOpts.mkBool false "Overwrite an existing user command.";
desc = helpers.defaultNullOpts.mkStr "" "A description of the command.";
# TODO: command-preview, need to grab a function here.
};
@ -41,7 +41,7 @@ in {
options.userCommands = mkOption {
type = types.attrsOf commandAttributes;
default = {};
description = "A list of user commands to add to the configuration";
description = "A list of user commands to add to the configuration.";
};
config = let

2
modules/doc.nix
View file

@ -2,6 +2,6 @@
options.enableMan = lib.mkOption {
type = lib.types.bool;
default = true;
description = "Install the man pages for nixvim options";
description = "Install the man pages for NixVim options.";
};
}

2
modules/highlights.nix
View file

@ -9,7 +9,7 @@ with lib; {
highlight = mkOption {
type = types.attrsOf helpers.nixvimTypes.highlight;
default = {};
description = "Define highlight groups";
description = "Define highlight groups.";
example = ''
highlight = {
Comment.fg = "#ff0000";

2
modules/lua-loader.nix
View file

@ -17,7 +17,7 @@ in {
- overrides loadfile
- adds the lua loader using the byte-compilation cache
- adds the libs loader
- removes the default Neovim loade
- removes the default Neovim loader
If `false`: Disables the experimental Lua module loader:
- removes the loaders