vesktop: more descriptive option description

This commit is contained in:
LilleAila 2024-07-02 22:29:50 +02:00
parent 499cfd5abd
commit 032d5e67a5
No known key found for this signature in database
GPG key ID: D1ACCDCF2B9B9799

View file

@ -15,8 +15,12 @@ in {
settings = lib.mkOption { settings = lib.mkOption {
type = jsonFormat.type; type = jsonFormat.type;
default = { }; default = { };
description = description = ''
"Vesktop settings to write to $HOME/.config/vesktop/settings.json"; Vesktop settings written to
{file}`$XDG_CONFIG_HOME/vesktop/settings.json`. See
<https://github.com/Vencord/Vesktop/blob/main/src/shared/settings.d.ts>
for available options.
'';
example = lib.literalExpression '' example = lib.literalExpression ''
{ {
appBadge = false; appBadge = false;
@ -37,17 +41,21 @@ in {
}; };
vencord = { vencord = {
useSystem = lib.mkEnableOption "vencord package from nixpkgs"; useSystem = lib.mkEnableOption "Vencord package from Nixpkgs";
theme = lib.mkOption { theme = lib.mkOption {
description = "The theme to use for vencord"; description = "The theme to use for Vencord";
default = null; default = null;
type = with lib.types; nullOr (oneOf [ lines path ]); type = with lib.types; nullOr (oneOf [ lines path ]);
}; };
settings = lib.mkOption { settings = lib.mkOption {
type = jsonFormat.type; type = jsonFormat.type;
default = { }; default = { };
description = description = ''
"Vencord settings to write to $HOME/.config/vesktop/settings/settings.json"; Vencord settings written to
{file}`$XDG_CONFIG_HOME/vesktop/settings/settings.json`. See
<https://github.com/Vendicated/Vencord/blob/main/src/api/Settings.ts>
for available options.
'';
example = lib.literalExpression '' example = lib.literalExpression ''
{ {
autoUpdate = false; autoUpdate = false;