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-rest.nix
View File

@@ -7,17 +7,17 @@ let
port = mkOption {
type = types.port;
default = 3001;
description = "REST server port.";
description = mdDoc "REST server port.";
};
docPort = mkOption {
type = types.port;
default = 4001;
description = "Swagger API documentation server port.";
description = mdDoc "Swagger API documentation server port.";
};
dataDir = mkOption {
type = types.path;
default = "/var/lib/clightning-rest";
description = "The data directory for clightning-rest.";
description = mdDoc "The data directory for clightning-rest.";
};
extraConfig = mkOption {
type = types.attrs;
@@ -25,7 +25,7 @@ let
example = {
DOMAIN = "mynode.org";
};
description = ''
description = mdDoc ''
Extra config options.
See: https://github.com/Ride-The-Lightning/c-lightning-REST#option-1-via-config-file-cl-rest-configjson
'';
@@ -34,7 +34,7 @@ let
group = mkOption {
readOnly = true;
default = clightning.group;
description = "The group under which clightning-rest is run.";
description = mdDoc "The group under which clightning-rest is run.";
};
# Rest server address.
# Not configurable. The server always listens on all interfaces: