!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

416 Members
Discussion about documentation improvements around the Nix ecosystem88 Servers

Load older messages


SenderMessageTime
13 Apr 2024
@tomberek:matrix.orgtomberekNot sure if that much nesting is ok: https://github.com/NixOS/nixpkgs/blob/master/doc/doc-support/lib-function-locations.nix#L25-L3104:16:49
@tomberek:matrix.orgtomberekIf I remove the "ipv4" layer of nesting and adjust the reference, it builds okay. So it seems like the doc infra doesn't allow that much?04:18:49
@djacu:matrix.orgdjacu Well that is unfortunate. Thanks for verifying my results tomberek 04:24:09
@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
@infinisil:matrix.orginfinisilAnswered on GitHub: https://github.com/NixOS/nixpkgs/pull/299409#issuecomment-205365022513:41:19
@infinisil:matrix.orginfinisil(it can work)13:41:35
@infinisil:matrix.orginfinisil terru: Yeah just a trace for now is my preference 13:42:04
@terru:raccoon.college@terru:raccoon.collegefair13:45:27
@terru:raccoon.college@terru:raccoon.collegeyou should've gotten a ping from github with the PR ;)13:45:56
@terru:raccoon.college@terru:raccoon.college * you should've just gotten a ping from github with the PR ;)13:46:00
@terru:raccoon.college@terru:raccoon.college grr forgot the final force-push changing the throw to lib.warn, sorry to everyone who now got pinged twice 🙈 13:48:16
@alex3829:matrix.org@alex3829:matrix.org joined the room.16:04:39
14 Apr 2024
@windchimesofmagic:matrix.org@windchimesofmagic:matrix.org left the room.17:37:29
15 Apr 2024
@soenke:hack-hro.desoenke joined the room.22:08:57
16 Apr 2024
@thoth101010:matrix.orgthoth joined the room.09:02:05
17 Apr 2024
@alex3829:matrix.org@alex3829:matrix.org changed their display name from alex3829 to real_z22.04:36:12
@alex3829:matrix.org@alex3829:matrix.org changed their display name from real_z22 to real_z2.05:33:42
@JoelMcCracken:matrix.orgJoelMcCracken joined the room.16:26:38
18 Apr 2024
@fractivore:cyberia.club@fractivore:cyberia.club left the room.02:27:17
@nscnt:matrix.org@nscnt:matrix.org joined the room.13:21:24
@olafklingt:matrix.org@olafklingt:matrix.orghow is the ":::" annotation called in sphinx? i wonder what the implications of more or less periods is.17:42:57
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @olafklingt:matrix.org
how is the ":::" annotation called in sphinx? i wonder what the implications of more or less periods is.
Admonition
18:10:51
@terru:raccoon.college@terru:raccoon.college oh btw, while we're talking about admonitions: the doc/README.md still contains links to docbook for the types of admonitions which are supported. Is this in any way useful or intentional, or just a migration leftover and therefore a bug? (I found it a little confusing when i noticed it) 19:55:09
19 Apr 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @terru:raccoon.college
oh btw, while we're talking about admonitions: the doc/README.md still contains links to docbook for the types of admonitions which are supported. Is this in any way useful or intentional, or just a migration leftover and therefore a bug? (I found it a little confusing when i noticed it)
Probably a leftover. Feel free to remove the links
08:59:31
@terru:raccoon.college@terru:raccoon.collegesure: https://github.com/NixOS/nixpkgs/pull/30532815:10:08

Show newer messages


Back to Room ListRoom Version: 6