movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-11 20:25:32 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos/doc: clean up defaults and examples

Browse source
This commit is contained in:
Naïm Favier 2021-10-03 18:06:03 +02:00
parent 330b1e08b8
commit 2ddc335e6f
No known key found for this signature in database
GPG key ID: 49B07322580B7EE2
584 changed files with 1612 additions and 1554 deletions
Download patch file Download diff file Expand all files Collapse all files

26
nixos/modules/programs/neovim.nix
View file

@ -47,18 +47,18 @@ in {
configure = mkOption {
type = types.attrs;
default = {};
example = literalExample ''
configure = {
customRC = $''''
example = literalExpression ''
{
customRC = '''
" here your custom configuration goes!
$'''';
packages.myVimPackage = with pkgs.vimPlugins; {
# loaded on launch
start = [ fugitive ];
# manually loadable by calling `:packadd $plugin-name`
opt = [ ];
};
''';
packages.myVimPackage = with pkgs.vimPlugins; {
# loaded on launch
start = [ fugitive ];
# manually loadable by calling `:packadd $plugin-name`
opt = [ ];
};
}
'';
description = ''
Generate your init file from your list of plugins and custom commands.
@ -69,7 +69,7 @@ in {
package = mkOption {
type = types.package;
default = pkgs.neovim-unwrapped;
defaultText = literalExample "pkgs.neovim-unwrapped";
defaultText = literalExpression "pkgs.neovim-unwrapped";
description = "The package to use for the neovim binary.";
};
@ -82,8 +82,8 @@ in {
runtime = mkOption {
default = {};
example = literalExample ''
runtime."ftplugin/c.vim".text = "setlocal omnifunc=v:lua.vim.lsp.omnifunc";
example = literalExpression ''
{ "ftplugin/c.vim".text = "setlocal omnifunc=v:lua.vim.lsp.omnifunc"; }
'';
description = ''
Set of files that have to be linked in <filename>runtime</filename>.