docs: clean up descriptions (#1061)

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

View file

@ -38,13 +38,13 @@ in {
options = {
files = lib.mkOption {
type = types.attrsOf fileModuleType;
description = "Files to include in the vim config";
description = "Files to include in the Vim config.";
default = {};
};
filesPlugin = lib.mkOption {
type = types.package;
description = "A derivation with all the files inside";
description = "A derivation with all the files inside.";
internal = true;
readOnly = true;
};

View file

@ -25,38 +25,38 @@ with lib; {
package = mkOption {
type = types.package;
default = pkgs.neovim-unwrapped;
description = "Neovim to use for nixvim";
description = "Neovim to use for NixVim.";
};
wrapRc = mkOption {
type = types.bool;
description = "Should the config be included in the wrapper script";
description = "Should the config be included in the wrapper script.";
default = false;
};
finalPackage = mkOption {
type = types.package;
description = "Wrapped neovim";
description = "Wrapped Neovim.";
readOnly = true;
};
initPath = mkOption {
type = types.str;
description = "The path to the init.lua file";
description = "The path to the `init.lua` file.";
readOnly = true;
visible = false;
};
initContent = mkOption {
type = types.str;
description = "The content of the init.lua file";
description = "The content of the `init.lua` file.";
readOnly = true;
visible = false;
};
printInitPackage = mkOption {
type = types.package;
description = "A tool to show the content of the generated init.lua file.";
description = "A tool to show the content of the generated `init.lua` file.";
readOnly = true;
visible = false;
};