lix-project/lix
20
58
Fork 31
Code Issues 359 Code Review (Gerrit) Projects 3 Releases Wiki Activity

Merge pull request #8263 from frederictobiasc/improve-doc-genericclosure

Browse source 
Documentation: Improve builtins.genericClosure
This commit is contained in:
Robert Hensing 2023-05-08 12:23:19 +02:00 committed by GitHub
parent 879e45247c f0d2b7eef3
commit cf8effdae2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/libexpr/primops.cc
View file

@ -706,12 +706,14 @@ static RegisterPrimOp primop_genericClosure(RegisterPrimOp::Info {
.arity = 1, .arity = 1,
.doc = R"( .doc = R"(
Take an *attrset* with values named `startSet` and `operator` in order to Take an *attrset* with values named `startSet` and `operator` in order to
return a *list of attrsets* by starting with the `startSet`, recursively return a *list of attrsets* by starting with the `startSet` and recursively
applying the `operator` function to each element. The *attrsets* in the applying the `operator` function to each `item`. The *attrsets* in the
`startSet` and produced by the `operator` must each contain value named `startSet` and the *attrsets* produced by `operator` must contain a value
`key` which are comparable to each other. The result is produced by named `key` which is comparable. The result is produced by calling `operator`
repeatedly calling the operator for each element encountered with a for each `item` with a value for `key` that has not been called yet including
unique key, terminating when no new elements are produced. For example, newly produced `item`s. The function terminates when no new `item`s are
produced. The resulting *list of attrsets* contains only *attrsets* with a
unique key. For example,
``` ```
builtins.genericClosure { builtins.genericClosure {