modules: update comments and description

This commit is contained in:
Gabriel Arazas 2024-07-31 13:29:51 +08:00
parent ae3541aeb2
commit 456ca00636
No known key found for this signature in database
GPG Key ID: 62104B43D00AA360
7 changed files with 26 additions and 16 deletions

View File

@ -9,7 +9,7 @@
description = ''
A set of [disko](https://github.com/nix-community/disko)
configurations readily available as part of the flake output to be
used by {program}`disko`. Could be useful as backup initialization
used by {command}`disko`. Could be useful as backup initialization
scripts for individual storage drives.
'';
};

View File

@ -1,3 +1,6 @@
# Declarative NixVim configurations because everything under the Nix ecosystem
# must be so declarative so we're setting up declarative ways of declaring
# those accursed setups to be exported in this flake.
{ inputs
, lib
, config

View File

@ -6,6 +6,8 @@
./ports.nix
];
# We can basically dump everything that is supposed to hold values for the
# entire system. This entry module should contain NOTHING ELSE!
options.state = lib.mkOption {
type = lib.types.submodule {
freeformType = with lib.types; attrsOf anything;
@ -17,14 +19,16 @@
source of truth for different parts (e.g., services, program) of the
system.
'';
example = {
services = {
postgresql.directory = "/var/lib/postgresql";
backup.ignoreDirectories = [
"node_modules"
".direnv"
];
};
};
example = lib.literalExpression ''
{
services = {
postgresql.directory = "/var/lib/postgresql";
backup.ignoreDirectories = [
"node_modules"
".direnv"
];
};
}
'';
};
}

View File

@ -151,6 +151,9 @@ in
curl
yt-dlp
] ++ lib.optional config.programs.git.enable config.programs.git.package;
defaultText = ''
Chromium, NodeJS, wget, yt-dlp, and git if enabled.
'';
example = lib.literalExpression ''
with pkgs; [
curl

View File

@ -1,4 +1,4 @@
{ config, lib, options, pkgs, ... }:
{ config, lib, options, ... }:
let
cfg = config.xdg.mime;

View File

@ -63,7 +63,7 @@ let
description = if isGlobal then ''
Global list of arguments to be appended to each Boxxy-enabled wrappers.
'' else ''
List of arguments to the {program}`boxxy` executable.
List of arguments to the {command}`boxxy` executable.
'';
default = [ ];
example = [ "--immutable" "--daemon" ];

View File

@ -65,7 +65,7 @@ in
type = with lib.types; attrsOf (submodule dbusFilterType);
description = ''
A global set of D-Bus addresses with their policies set with
{program}`xdg-dbus-proxy` for each D-Bus address specified on the
{command}`xdg-dbus-proxy` for each D-Bus address specified on the
Bubblewrap-enabled wrappers. See {manpage}`xdg-dbus-proxy(1)` for
more details.
'';
@ -102,7 +102,7 @@ in
type = with lib.types; listOf str;
description = ''
List of proxy-specific arguments to be passed to
{program}`xdg-dbus-proxy`.
{command}`xdg-dbus-proxy`.
'';
default = [ ];
};
@ -131,7 +131,7 @@ in
extraArgs = lib.mkOption {
type = with lib.types; listOf str;
description = ''
List of arguments to be passed to {program}`xdg-dbus-proxy`.
List of arguments to be passed to {command}`xdg-dbus-proxy`.
'';
default = [ ];
};
@ -140,7 +140,7 @@ in
type = with lib.types; attrsOf (submodule addressesModule);
description = ''
A set of addresses to be applied with the filter through
{program}`xdg-dbus-proxy`.
{command}`xdg-dbus-proxy`.
'';
default = { };
example = {