jacobpascual/nix-bitcoin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

treewide: use mdDoc for descriptions

Browse Source 
Enable markdown syntax (instead of docbook) for descriptions.
This only affects external doc tooling that renders the descriptions.
This commit is contained in:
Erik Arvstedt
2022-12-18 13:13:47 +01:00
parent a9c1995ed9
commit 109dccca27
33 changed files with 292 additions and 292 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
modules/clightning-plugins/feeadjuster.nix
View File

@@ -6,7 +6,7 @@ let
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = mdDoc ''
Enable feeaduster (clightning plugin).
This plugin auto-updates channel fees to keep channels balanced.
@@ -18,17 +18,17 @@ let
fuzz = mkOption {
type = types.bool;
default = true;
description = "Enable update threshold randomization and hysteresis.";
description = mdDoc "Enable update threshold randomization and hysteresis.";
};
adjustOnForward = mkOption {
type = types.bool;
default = false;
description = "Automatically update fees on forward events.";
description = mdDoc "Automatically update fees on forward events.";
};
method = mkOption {
type = types.enum [ "soft" "default" "hard" ];
default = "default";
description = ''
description = mdDoc ''
Adjustment method to calculate channel fees.
`soft`: less difference when adjusting fees.
`hard`: greater difference when adjusting fees.
@@ -37,7 +37,7 @@ let
adjustDaily = mkOption {
type = types.bool;
default = true;
description = "Automatically update fees daily.";
description = mdDoc "Automatically update fees daily.";
};
};