| 17 Jul 2021 |
David Arnold (blaggacao) | The last one could be:
internalOverlays -> exportPackages | 13:30:36 |
@kraftnix:matrix.org | I had not seen nixdoc, if it does what it says on the can this is something i've been wondering why nixos doesn't already have, my solution to searching my library is to look at source code currently âšī¸, will this generate docs that can be viewed in REPL as well? so :doc lib.mapAttrsToList for example? | 13:33:38 |
David Arnold (blaggacao) | I havn't checked. But ryamtm is vanguarding it so, I tacitly assume it's as best as it can get. | 13:34:48 |
@kraftnix:matrix.org | Also wanted to mention, I upgraded recently and had a look into bud, it is super cool and i'm going to start merging in some of my bespoke ctl into it, great work David Arnoldđ | 13:37:39 |
fufexan | In reply to @blaggacao:matrix.org fufexan that's great news. I'm on the same task for digga. Can we settle on using something like https://github.com/nix-community/nixdoc/pull/25 ? So I can render the library function docs also in the digga docs? W.d.y.t.? sure thing, sounds good | 13:55:22 |
fufexan | In reply to @blaggacao:matrix.org The last one could be:
internalOverlays -> exportPackages great, updating now | 13:56:07 |
Narice | Hey! I cannot build my system after doing a flk update right now, is there something going on right now? I posted an issue on GH with all the info ;) | 15:10:26 |
fufexan | David Arnold: is this how I should proceed with the fup docs as well? https://github.com/divnix/digga/blob/develop/doc/mkFlakeOptions.md | 15:45:51 |
fufexan | also, for inline synopsis https://github.com/divnix/digga/blob/develop/src/generators.nix#L4-L10 | 15:46:41 |
David Arnold (blaggacao) | In reply to @fufexan:matrix.org David Arnold: is this how I should proceed with the fup docs as well? https://github.com/divnix/digga/blob/develop/doc/mkFlakeOptions.md fufexan this is nixos-autogenerated file from the module system, so it's not the relevant syntax for library docs. | 15:52:10 |
David Arnold (blaggacao) | The nixdoc "syntax" is:
/* This function does the thing a number of times. */ myFunction = # The thing to do thing: # How many times to do it n: doNTimes n thing
| 15:53:08 |
David Arnold (blaggacao) | * The nixdoc "syntax" is:
```
/* This function does the thing a number of times. */
myFunction =
# The thing to do
thing:
# How many times to do it n: doNTimes:
n thing
``` | 15:53:51 |
David Arnold (blaggacao) | It also recognizes (lines or paragraphs?) That start with Example: or Type: in the docstrings and will render them apropriately. | 15:54:56 |
David Arnold (blaggacao) | I think the key difference with the current synopsis (e.g. in the generators) are the argument comments. | 15:55:51 |
fufexan | I haven't seen much of that format in nixpkgs or anywhere | 15:56:05 |
fufexan | that's why I was asking | 15:56:22 |