!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

414 Members
Discussion about documentation improvements around the Nix ecosystem83 Servers

You have reached the beginning of time (for this room).


SenderMessageTime
13 Apr 2024
@olafklingt:matrix.org@olafklingt:matrix.orgis your use of doc comment inentional? Starting with "/**"? https://github.com/nix-community/nixdoc10:48:13
@olafklingt:matrix.org@olafklingt:matrix.orgSorry yes obviously it's intentional 😄 sorry for the noise 10:50:16
@terru:raccoon.college@terru:raccoon.college *

hey all, i recently got it into my head to write a little tool which automatically edits nix files without messing them up, and got it to a point where it can remove e.g. all mentions of lib.mdDoc from nixpkgs. I have a changeset of it applied to master or ~an hour ago here: https://github.com/NixOS/nixpkgs/compare/5d401f9ed627a869fd231f63e4f8380022dcded5...stuebinm:nixpkgs:eed6c7c5de883d78d8185adaf4949c0fb7f8f44f

i have not opened a pull request with it because that'd just ping a lot of people and i'm not sure if it would be accepted or people here would even be interested, so I thought I'd ask here beforehand

13:13:37
@infinisil:matrix.orginfinisil
In reply to @terru:raccoon.college
fair enough (should it be an outright error or just a trace for now?). if nothing else comes up i'd open a PR with this built on then-current master sometime tomorrow
You can use lib.warn (which gives a trace) :)
13:36:52
@terru:raccoon.college@terru:raccoon.collegei know. my question was more: should it give a trace, or should it give a hard (failing) error directly?13:38:22
@terru:raccoon.college@terru:raccoon.collegebut i'll use lib.warn if that's preferred (just be a second, I was literally just writing the PR message for this 😄)13:39:15

Show newer messages


Back to Room ListRoom Version: 6