docs: clean up descriptions (#1061)

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.

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.
       '';
     };
   };

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 (!)";
+      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";
+      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";
+      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";
+      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";
+      force = helpers.defaultNullOpts.mkBool false "Overwrite an existing user command.";
-      desc = helpers.defaultNullOpts.mkStr "" "A description of the 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

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.";
   };
 }

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";

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

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" } }'\'

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;
     };

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;
     };