movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-11 12:15:34 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos/*: convert internal option descriptions to MD

Browse source 
we'll have to do it eventually, may as well be now.
This commit is contained in:
pennae 2022-08-29 01:38:36 +02:00
parent ef176dcf7e
commit 9547123258
60 changed files with 116 additions and 116 deletions
Download patch file Download diff file Expand all files Collapse all files

4
nixos/modules/misc/assertions.nix
View file

@ -11,7 +11,7 @@ with lib;
internal = true;
default = [];
example = [ { assertion = false; message = "you can't enable this for that reason"; } ];
description = ''
description = lib.mdDoc ''
This option allows modules to express conditions that must
hold for the evaluation of the system configuration to
succeed, along with associated error messages for the user.
@ -23,7 +23,7 @@ with lib;
default = [];
type = types.listOf types.str;
example = [ "The `foo' service is deprecated and will go away soon!" ];
description = ''
description = lib.mdDoc ''
This option allows modules to show warnings to users during
the evaluation of the system configuration.
'';