suzanne.soy/nixpkgs
1
0
Fork 0
Code Issues Pull Requests 2 Actions Packages Projects Releases Wiki Activity

lib/generators: improve documentation a bit

Browse Source
This commit is contained in:
Profpatsch 2018-03-26 17:28:17 +02:00
parent 219ba583b2
commit a7e45fdd8e
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
lib/generators.nix
View File

@ -4,6 +4,12 @@
* They all follow a similar interface: * They all follow a similar interface:
* generator { config-attrs } data * generator { config-attrs } data
* *
* `config-attrs` are “holes” in the generators
* with sensible default implementations that
* can be overwritten. The default implementations
* are mostly generators themselves, called with
* their respective default values; they can be reused.
*
* Tests can be found in ./tests.nix * Tests can be found in ./tests.nix
* Documentation in the manual, #sec-generators * Documentation in the manual, #sec-generators
*/ */
@ -20,6 +26,8 @@ in
rec { rec {
## -- HELPER FUNCTIONS & DEFAULTS --
/* Generate a line of key k and value v, separated by /* Generate a line of key k and value v, separated by
* character sep. If sep appears in k, it is escaped. * character sep. If sep appears in k, it is escaped.
* Helper for synaxes with different separators. * Helper for synaxes with different separators.
@ -35,6 +43,9 @@ rec {
"${libStr.escape [sep] k}${sep}${mkValueString v}"; "${libStr.escape [sep] k}${sep}${mkValueString v}";
## -- FILE FORMAT GENERATORS --
/* Generate a key-value-style config file from an attrset. /* Generate a key-value-style config file from an attrset.
* *
* mkKeyValue is the same as in toINI. * mkKeyValue is the same as in toINI.