public
/
nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Fixes documented default option for `<name>` for submodules. (#40464) 

Fixes #40463

This is related to change 1d56d0c8a7
This commit is contained in:
Samuel Dionne-Riel 2018-05-16 12:11:36 -04:00 committed by xeji
parent 4fbd5a6583
commit 136f1c4706
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
lib/types.nix
View File

@ -372,7 +372,13 @@ rec {
# This is mandatory as some option declaration might use the # This is mandatory as some option declaration might use the
# "name" attribute given as argument of the submodule and use it # "name" attribute given as argument of the submodule and use it
# as the default of option declarations. # as the default of option declarations.
args.name = "&lt;name&gt;"; #
# Using lookalike unicode single angle quotation marks because
# of the docbook transformation the options receive. In all uses
# &gt; and &lt; wouldn't be encoded correctly so the encoded values
# would be used, and use of `<` and `>` would break the XML document.
# It shouldn't cause an issue since this is cosmetic for the manual.
args.name = "‹name›";
}).options; }).options;
getSubModules = opts'; getSubModules = opts';
substSubModules = m: submodule m; substSubModules = m: submodule m;