!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

437 Members
Discussion about documentation improvements around the Nix ecosystem93 Servers

Load older messages


SenderMessageTime
3 Nov 2023
@fricklerhandwerk:matrix.orgfricklerhandwerkThe error complains about NIX_PATH not containing nixpkgs15:33:13
@alejandrosame:matrix.orgalejandrosameAh, I was talking about the error in the issue https://github.com/NixOS/nix.dev/issues/78716:06:38
@asymmetric:matrix.dapp.org.ukasymmetrichttps://github.com/NixOS/nix.dev/pull/645#issuecomment-179230301517:40:13
@asymmetric:matrix.dapp.org.ukasymmetricAny comments on this one?17:40:18
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @fricklerhandwerk:matrix.org
I’m not sure why there is a need for NIX_PATH to be set. Why and when did it even break? It worked a couple of days ago.
It could be something on my end. Or at least, I have the same problem with the old ./live script
17:46:22
@bzzm3r:matrix.org@bzzm3r:matrix.org joined the room.19:50:59
4 Nov 2023
@antifuchs:asf.computerantifuchs joined the room.14:32:26
@antifuchs:asf.computerantifuchsjust noticed the entire lib.meta attrset of functions isn't documented in the nixpkgs manual yet... they have source code comments, but none of the functions can be found. I'd be happy to try and craft a PR for that, but am wondering if I'm missing some policy / better taxonomy or something?14:33:35
@qyriad:matrix.org@qyriad:matrix.org joined the room.14:44:14
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @antifuchs:asf.computer
just noticed the entire lib.meta attrset of functions isn't documented in the nixpkgs manual yet... they have source code comments, but none of the functions can be found. I'd be happy to try and craft a PR for that, but am wondering if I'm missing some policy / better taxonomy or something?
That would be great. I don’t know any details, but IIRC it just needs some wiring up in the table of contents. And then likely fixing a lot of rendering bugs, but that could be done later as well.
14:45:49
@antifuchs:asf.computerantifuchsnice! ok, I'll see what I can do (:14:46:05
@antifuchs:asf.computerantifuchs fricklerhandwerk: while I have your attention on the library TOC, do you think it (https://nixos.org/manual/nixpkgs/unstable/#sec-functions-library) should be sorted alphabetically? the order doesn't make much sense to me and that makes it difficult to find things that are missing 15:03:08
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @antifuchs:asf.computer
fricklerhandwerk: while I have your attention on the library TOC, do you think it (https://nixos.org/manual/nixpkgs/unstable/#sec-functions-library) should be sorted alphabetically? the order doesn't make much sense to me and that makes it difficult to find things that are missing

Sure, I wouldn’t know why not.

Side note: I’m not that involved in the Nixpkgs manual because the Nix manual and nix.dev are enough to deal with, so my knowledge and opinions are quite superficial. There are likely other people who will have more substantial things to say: infinisil Robert Hensing (roberth) @pennae alejandrosame come
to mind.

15:24:25
@antifuchs:asf.computerantifuchsoh, haha! I see (:15:24:37
@antifuchs:asf.computerantifuchswould love to hear from you all about that - I have a newfound passion for documenting library functions (:15:28:45
@antifuchs:asf.computerantifuchs here's the first PR, to add the lib.meta attrset of functions to the ToC: https://github.com/NixOS/nixpkgs/pull/265478 15:49:25
@proofconstruction:matrix.orgproofconstructionThanks for picking up a shovel!15:49:49
@qyriad:matrix.org@qyriad:matrix.orgI had no idea these functions existed before, so thank you for that!15:52:17
@antifuchs:asf.computerantifuchsI would love to make the ToC be auto-generated with an assertion that when adding a section, a tagline is added too17:45:05
@antifuchs:asf.computerantifuchs(this seems difficult, as the lib/ dir is pretty jumbled)18:06:41
@olafklingt:matrix.org@olafklingt:matrix.org
In reply to @antifuchs:asf.computer
here's the first PR, to add the lib.meta attrset of functions to the ToC: https://github.com/NixOS/nixpkgs/pull/265478
maybe this project is interesting to you https://nix-community.github.io/docnix/reference/lib/meta/lib-meta-addmetaattrs/ it builds from a fork of nixpkgs not sure how substantial the difference is.
18:29:17
@antifuchs:asf.computerantifuchs Oooh, I didn’t know about that yet! Looks very useful indeed 18:32:43
5 Nov 2023
@atka:matrix.org@atka:matrix.org joined the room.01:18:52
@infinisil:matrix.orginfinisil antifuchs: I do think the order is somewhat important. In particular lib.path, lib.filesystem and lib.sources/lib.fileset should be in that order, because they build up on the previous one 10:54:23
@infinisil:matrix.orginfinisilBut then again, the path library also isn't that important, maybe it ahould come last :P10:55:04
@infinisil:matrix.orginfinisilI guess I don't care very much tbh :)10:55:20
@antifuchs:asf.computerantifuchshahaha, makes sense14:02:03
@antifuchs:asf.computerantifuchsif there are logical groupings, maybe we can arrange them via subsections? but I think in source, having the library attributes be alphabetical would make it much easier to do a mental tally14:02:40
6 Nov 2023
@roberthensing:matrix.orgRobert Hensing (roberth)
In reply to @infinisil:matrix.org
antifuchs: I do think the order is somewhat important. In particular lib.path, lib.filesystem and lib.sources/lib.fileset should be in that order, because they build up on the previous one
that's too much inference, and nobody expect much from an ordered lists, because dependency graphs > 3 nodes are basically never ordered lists
11:51:53
@roberthensing:matrix.orgRobert Hensing (roberth)subsections can only represent trees, and only if they're not too deep, so those are not suitable either11:52:51

Show newer messages


Back to Room ListRoom Version: 6