`builtins.derivation` is not documented #436

New issue

Open

opened 2024-07-07 19:26:12 +00:00 by lunaphied · 3 comments

lunaphied commented

2024-07-07 19:26:12 +00:00

Owner

Problem

Much like lix-project/lix#73, builtins.derivation isn't documented (intentionally so, as it's supposedly documented "elsewhere", except it is not.)

Proposal

Produce documentation for builtins.derivation, which is a fairly simple wrapper around builtins.strictDerivation to make working with it easier and allow the output to be computed lazily.

Checklist

checked [latest Lix manual] [source]
checked [documentation issues] and [recent documentation changes] for possible duplicates

## Problem Much like lix-project/lix#73, `builtins.derivation` isn't documented (intentionally so, as it's supposedly documented "elsewhere", except it is not.) ## Proposal Produce documentation for `builtins.derivation`, which is a fairly simple wrapper around `builtins.strictDerivation` to make working with it easier and allow the output to be computed lazily. ## Checklist - [x] checked [latest Lix manual] \([source]\) - [x] checked [documentation issues] and [recent documentation changes] for possible duplicates

lunaphied added the

docs

E/help wanted

labels 2024-07-07 19:26:12 +00:00

lunaphied added the

E/easy

label 2024-07-07 19:33:37 +00:00

pennae commented

2024-07-07 19:37:26 +00:00

Owner

it's documented here: https://docs.lix.systems/manual/lix/nightly/language/derivations.html, and the list of builtin functions has a link there too. there's no documentation that's accessible from the repl though, and should definitely be rectified (which we actually can! thanks lix-doc :3)

it's documented here: <https://docs.lix.systems/manual/lix/nightly/language/derivations.html>, and the list of builtin functions has a link there too. there's no documentation that's accessible from the repl though, and should definitely be rectified (which we actually can! thanks lix-doc :3)

lunaphied commented

2024-07-07 19:39:25 +00:00

Author

Owner

I don't consider builtins that aren't documented in the REPL to be actually documented, and we don't even need lix-doc for this (though I noticed this because it falls back to trying to find docs on the builtins.derivation lambda itself, and fails because there are none). We just need to actually add docs to it's builtin definition.

I don't consider builtins that aren't documented in the REPL to be actually documented, and we don't even need lix-doc for this (though I noticed this because it falls back to trying to find docs on the `builtins.derivation` lambda itself, and fails because there are none). We just need to actually add docs to it's builtin definition.

lunaphied added the

label 2024-07-07 19:39:32 +00:00