diff --git a/docs/man/nixvim-header.5 b/docs/man/nixvim-header.5 index 827c0461..5988313c 100644 --- a/docs/man/nixvim-header.5 +++ b/docs/man/nixvim-header.5 @@ -1,4 +1,4 @@ -.TH "NIXVIM" "5" "01/01/1980" "Nixvim" "Nixvim Reference Pages" +.TH "NIXVIM" "5" "01/01/1980" "NixVim" "NixVim Reference Pages" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -6,10 +6,10 @@ .\" enable line breaks after slashes .cflags 4 / .SH "NAME" -nixvim options specification +NixVim options specification .SH "DESCRIPTION" .PP -This page lists all the options that can be used in nixvim. Nixvim can either be used as a Home-Manager module, an NixOS module or a standalone package. Please refer to the installation instructions for more details. +This page lists all the options that can be used in NixVim. It can either be used as a Home-Manager module, an NixOS module or a standalone package. Please refer to the installation instructions for more details. .SH "OPTIONS" .PP -You can use the following options in a nixvim module. +You can use the following options in a NixVim module. diff --git a/lib/neovim-plugin.nix b/lib/neovim-plugin.nix index be47bddc..ee94cec6 100644 --- a/lib/neovim-plugin.nix +++ b/lib/neovim-plugin.nix @@ -31,7 +31,7 @@ with lib; { type = with types; attrsOf anything; description = '' These attributes will be added to the table parameter for the setup function. - (Can override other attributes set by nixvim) + Typically, it can override NixVim's default settings. ''; }; }; diff --git a/modules/commands.nix b/modules/commands.nix index dd508f64..7b694a54 100644 --- a/modules/commands.nix +++ b/modules/commands.nix @@ -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 diff --git a/modules/doc.nix b/modules/doc.nix index e93a6676..a178b466 100644 --- a/modules/doc.nix +++ b/modules/doc.nix @@ -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."; }; } diff --git a/modules/highlights.nix b/modules/highlights.nix index fa8838ee..1efe52ac 100644 --- a/modules/highlights.nix +++ b/modules/highlights.nix @@ -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"; diff --git a/modules/lua-loader.nix b/modules/lua-loader.nix index c07b7759..0a88b265 100644 --- a/modules/lua-loader.nix +++ b/modules/lua-loader.nix @@ -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 diff --git a/plugins/none-ls/helpers.nix b/plugins/none-ls/helpers.nix index d3949e9c..d89488d6 100644 --- a/plugins/none-ls/helpers.nix +++ b/plugins/none-ls/helpers.nix @@ -2,7 +2,7 @@ mkServer = { name, sourceType, - description ? "${name} source, for none-ls.", + description ? "${name} built-in source for none-ls", package ? null, extraPackages ? [], ... @@ -25,7 +25,7 @@ package = mkOption { type = types.package; default = package; - description = "Package to use for ${name} by none-ls"; + description = "Package to use for ${name} by none-ls."; }; }; in { @@ -37,7 +37,7 @@ withArgs = mkOption { default = null; type = with types; nullOr str; - description = ''Raw Lua code to be called with the with function''; + description = ''Raw Lua code passed as an argument to the source's `with` method.''; # Not sure that it makes sense to have the same example for all servers # example = '' # '\'{ extra_args = { "--no-semi", "--single-quote", "--jsx-single-quote" } }'\' diff --git a/wrappers/modules/files.nix b/wrappers/modules/files.nix index 9e278d34..299fcd4a 100644 --- a/wrappers/modules/files.nix +++ b/wrappers/modules/files.nix @@ -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; }; diff --git a/wrappers/modules/output.nix b/wrappers/modules/output.nix index 27c2fe2c..e1c6a2fd 100644 --- a/wrappers/modules/output.nix +++ b/wrappers/modules/output.nix @@ -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; };