Skip to content

Commit c173a64

Browse files
committed
refactor(modules): Remove lib.mdDoc because it's deprecated
1 parent 7191711 commit c173a64

File tree

5 files changed

+116
-59
lines changed

5 files changed

+116
-59
lines changed

modules/geth/args.nix

Lines changed: 43 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ with lib; {
2525
type = types.nullOr (types.listOf types.str);
2626
default = null;
2727
description = "API's offered over the HTTP-RPC interface";
28-
example = ["net" "eth"];
28+
example = [
29+
"net"
30+
"eth"
31+
];
2932
};
3033

3134
corsdomain = mkOption {
@@ -49,7 +52,10 @@ with lib; {
4952
Comma separated list of virtual hostnames from which to accept requests (server enforced).
5053
Accepts '*' wildcard.
5154
'';
52-
example = ["localhost" "geth.example.org"];
55+
example = [
56+
"localhost"
57+
"geth.example.org"
58+
];
5359
};
5460
};
5561

@@ -71,7 +77,10 @@ with lib; {
7177
type = types.nullOr (types.listOf types.str);
7278
default = null;
7379
description = "APIs to enable over WebSocket";
74-
example = ["net" "eth"];
80+
example = [
81+
"net"
82+
"eth"
83+
];
7584
};
7685
};
7786

@@ -92,7 +101,10 @@ with lib; {
92101
type = types.listOf types.str;
93102
default = ["localhost"];
94103
description = "List of virtual hostnames from which to accept requests.";
95-
example = ["localhost" "geth.example.org"];
104+
example = [
105+
"localhost"
106+
"geth.example.org"
107+
];
96108
};
97109

98110
jwtsecret = mkOption {
@@ -118,29 +130,38 @@ with lib; {
118130
};
119131

120132
influxdb = {
121-
enable = mkEnableOption (mdDoc "Enable metrics export/push to an external InfluxDB database");
133+
enable = mkEnableOption "Enable metrics export/push to an external InfluxDB database";
122134
endpoint = mkOption {
123135
type = types.nullOr types.str;
124136
default = null;
125-
description = mdDoc "InfluxDB API endpoint to report metrics to.";
137+
description = "InfluxDB API endpoint to report metrics to.";
126138
};
127139

128140
username = mkOption {
129141
type = types.nullOr types.str;
130142
default = null;
131-
description = mdDoc "Username to authorize access to the database.";
143+
description = "Username to authorize access to the database.";
132144
};
133145

134146
password = mkOption {
135147
type = types.nullOr types.str;
136148
default = null;
137-
description = mdDoc "Password to authorize access to the database.";
149+
description = "Password to authorize access to the database.";
138150
};
139151
};
140152
};
141153

142154
network = mkOption {
143-
type = types.nullOr (types.enum ["goerli" "holesky" "kiln" "rinkeby" "ropsten" "sepolia"]);
155+
type = types.nullOr (
156+
types.enum [
157+
"goerli"
158+
"holesky"
159+
"kiln"
160+
"rinkeby"
161+
"ropsten"
162+
"sepolia"
163+
]
164+
);
144165
default = null;
145166
description = "The network to connect to. Mainnet (null) is the default ethereum network.";
146167
};
@@ -178,13 +199,21 @@ with lib; {
178199
};
179200

180201
syncmode = mkOption {
181-
type = types.enum ["snap" "fast" "full" "light"];
202+
type = types.enum [
203+
"snap"
204+
"fast"
205+
"full"
206+
"light"
207+
];
182208
default = "snap";
183209
description = "Blockchain sync mode.";
184210
};
185211

186212
gcmode = mkOption {
187-
type = types.enum ["full" "archive"];
213+
type = types.enum [
214+
"full"
215+
"archive"
216+
];
188217
default = "full";
189218
description = "Blockchain garbage collection mode.";
190219
};
@@ -204,20 +233,20 @@ with lib; {
204233
ipcEnable = mkOption {
205234
type = types.bool;
206235
default = false;
207-
description = mdDoc "Enable the IPC-RPC server";
236+
description = "Enable the IPC-RPC server";
208237
};
209238

210239
snapshot = mkOption {
211240
type = types.bool;
212241
default = true;
213-
description = mdDoc "Enables snapshot-database mode";
242+
description = "Enables snapshot-database mode";
214243
};
215244

216245
discovery = {
217246
port = mkOption {
218247
type = types.either types.port (types.enum ["\${DISCOVERY_PORT}"]);
219248
default = 30303;
220-
description = mdDoc "Use a custom UDP port for P2P discovery.";
249+
description = "Use a custom UDP port for P2P discovery.";
221250
};
222251
};
223252
}

modules/geth/options.nix

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,18 @@
3131
};
3232

3333
argsFromFile = {
34-
enable = mkEnableOption (mdDoc "Create a file in the etc directory from which arguments can be modified");
34+
enable = mkEnableOption "Create a file in the etc directory from which arguments can be modified";
3535
group = mkOption {
3636
type = types.str;
3737
default = "";
3838
example = "devops";
39-
description = lib.mdDoc "Group which can modify the arguments file";
39+
description = "Group which can modify the arguments file";
4040
};
4141
mode = mkOption {
4242
type = types.str;
4343
default = "0664";
4444
example = "0060";
45-
description = lib.mdDoc "Arguments file mode";
45+
description = "Arguments file mode";
4646
};
4747
};
4848

modules/nethermind/options.nix

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,18 @@
3131
};
3232

3333
argsFromFile = {
34-
enable = mkEnableOption (mdDoc "Create a file in the etc directory from which arguments can be modified");
34+
enable = mkEnableOption "Create a file in the etc directory from which arguments can be modified";
3535
group = mkOption {
3636
type = types.str;
3737
default = "";
3838
example = "devops";
39-
description = lib.mdDoc "Group which can modify the arguments file";
39+
description = "Group which can modify the arguments file";
4040
};
4141
mode = mkOption {
4242
type = types.str;
4343
default = "0664";
4444
example = "0060";
45-
description = lib.mdDoc "Arguments file mode";
45+
description = "Arguments file mode";
4646
};
4747
};
4848

0 commit comments

Comments
 (0)