!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

438 Members
Discussion about documentation improvements around the Nix ecosystem93 Servers

Load older messages


SenderMessageTime
30 Jan 2022
@joepie91:pixie.townjoepie91 🏳️‍🌈oops00:16:48
@joepie91:pixie.townjoepie91 🏳️‍🌈fixed00:17:04
@jtojnar:matrix.orgJan Tojnar there is also pkgs.nix-gitignore if you want to avoid flakes https://nixos.org/manual/nixpkgs/stable/#sec-pkgs-nix-gitignore 00:21:20
@joepie91:pixie.townjoepie91 🏳️‍🌈ah, handy00:22:39
@joepie91:pixie.townjoepie91 🏳️‍🌈will have a look at that later00:22:49
@jtojnar:matrix.orgJan Tojnar but the functions I had in mind and actually used are lib.sources.cleanSource & co. 00:23:05
@jtojnar:matrix.orgJan Tojnar which are based on builtins.path 00:23:13
@joepie91:pixie.townjoepie91 🏳️‍🌈are those documented?00:23:21
@jtojnar:matrix.orgJan Tojnarnot sure, I mostly just look to code for docs00:23:53
@joepie91:pixie.townjoepie91 🏳️‍🌈right :p00:24:20
@jtojnar:matrix.orgJan Tojnarlooks like it is incomplete for some reason00:25:51
@jtojnar:matrix.orgJan Tojnarhttps://nixos.org/manual/nixpkgs/stable/#sec-functions-library-sources00:25:52
@joepie91:pixie.townjoepie91 🏳️‍🌈yeah that section looked weirdly empty to me00:26:46
@joepie91:pixie.townjoepie91 🏳️‍🌈couldn't really derive any understanding from it00:26:59
@jtojnar:matrix.orgJan Tojnarlooks like it might only extract C style-comments00:27:25
@jtojnar:matrix.orgJan Tojnarrather than the shell-style ones00:27:33
@joepie91:pixie.townjoepie91 🏳️‍🌈there's at least one misparse too00:27:36
@jtojnar:matrix.orgJan Tojnarwhich are used for most docs in the sources.nix00:27:50
@joepie91:pixie.townjoepie91 🏳️‍🌈under 5.1.4.4. lib.trivial.concat00:27:51
@joepie91:pixie.townjoepie91 🏳️‍🌈alright, I've been at this for 8-9 hours and it's nearly bedtime so I gotta detach now :p feel free to leave any further review comments and/or questions and I'll read them in the morning00:29:38
@joepie91:pixie.townjoepie91 🏳️‍🌈or what passes as 'morning' for me anyway00:29:52
@joepie91:pixie.townjoepie91 🏳️‍🌈(thanks, btw!)00:44:18
@jtojnar:matrix.orgJan Tojnarany comments on https://github.com/NixOS/nixpkgs/pull/157336?19:09:44
@asymmetric:matrix.dapp.org.ukasymmetric i'm just a bit confused about why you switched some multilines to #, e.g. in lib/trivial.nix, but then also converted some single-line comments to /* ... */ 19:20:47
@asymmetric:matrix.dapp.org.ukasymmetric * Jan Tojnar: i'm just a bit confused about why you switched some multilines to #, e.g. in lib/trivial.nix, but then also converted some single-line comments to /* ... */ 19:21:04
@asymmetric:matrix.dapp.org.ukasymmetric ah, is it that comments inside code are now always with #? 19:21:37
@jtojnar:matrix.orgJan Tojnar asymmetric: yeah, nixdoc extracts c-style comments and ignores shell-style ones 19:22:07
1 Feb 2022
@aktaboot:matrix.orgaktaboot joined the room.01:01:57
@aktaboot:matrix.orgaktaboot

Hey ! Just some feedback:

I felt that it was weird that the manuals where not easily accessible from the website.

You have to go to Learn and then scroll all the way down to see them.

Some links to the docs in the headers or/and the footers, visible on all pages would be more intuitive imo.

09:22:46
@aktaboot:matrix.orgaktaboot *

Hey ! Just some feedback:

I felt that it was weird that the manuals were not easily accessible from the website.

You have to go to Learn and then scroll all the way down to see them.

Some links to the docs in the headers or/and the footers, visible on all pages would be more intuitive imo.

09:22:57

Show newer messages


Back to Room ListRoom Version: 6