!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

438 Members
Discussion about documentation improvements around the Nix ecosystem91 Servers

Load older messages


SenderMessageTime
3 Nov 2023
@infinisil:matrix.orginfinisil Johannes Kirschbauer @hsjobeki: I'm the main user of those. They're added by nixdoc. I'm using them because it's the only way to reference functions. 09:12:35
@infinisil:matrix.orginfinisilI generally inspect the web elements to find them09:13:29
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @infinisil:matrix.org
I generally inspect the web elements to find them

And now we depend on a certain web-elements beeing present on the same page ^^.
I'll try to find a solution for this., because it hinders us moving to newer formats. Any suggestions?

idea:

Something like
see [lib.lists.foldl]

Without any further. The rendering framework can transform this into references for achor tags, if it uses them.
I tried using a different rendering framework that uses seperate pages and doesnt have those exact anchors.

09:17:13
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @infinisil:matrix.org
I generally inspect the web elements to find them
*

And now we depend on a certain web-elements beeing present on the same page ^^.
I'll try to find a solution for this., because it hinders us moving to newer formats. Any suggestions?

idea:

Something like
see [lib.lists.foldl']

Without any further. The rendering framework can transform this into references for achor tags, if it uses them.
I tried using a different rendering framework that uses seperate pages and doesnt have those exact anchors.

09:17:39
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host

That opens the box of pandora: context aware references ^^

{
   /**
   # Params

  - [a] A number
  - [b] Another number

   */
   lib.foo = a: b: a +b;
}

😃

09:19:43
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host *

That opens the box of pandora: context aware references ^^

{
   /**
   See also [lib.trivial.add]
   # Params

  - [a] A number
  - [b] Another number

   */
   lib.foo = a: b: a +b;
}

😃

09:20:17
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostSome references refer to internal things, while some refer to external attributes. Just playing around with the idea 😃09:21:31
@asymmetric:matrix.dapp.org.ukasymmetric

Can't run nix.dev devmode:

āÆ nix-shell --run devmode
error:
       … while calling the 'import' builtin

         at «string»:1:2:

            1| (import <nixpkgs> {}).bashInteractive
             |  ^

       … while calling the 'findFile' builtin

         at «string»:1:9:

            1| (import <nixpkgs> {}).bashInteractive
             |         ^

       error: file 'nixpkgs' was not found in the Nix search path (add it using $NIX_PATH or -I)

       at «none»:0: (source not available)
will use bash from your environment
Doing an initial build of the docs...
09:21:36
@asymmetric:matrix.dapp.org.ukasymmetric cc fricklerhandwerk alejandrosame 09:22:33
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host Whats in your $NIX_PATH, is it empty ? 09:23:00
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @johannes.kirschbauer:scs.ems.host
Whats in your $NIX_PATH, is it empty ?
nope, it has nixpkgs=/nix/store/...
09:23:56
@infinisil:matrix.orginfinisil Johannes Kirschbauer @hsjobeki: We can freely change the source code (just needs some automated/manual work) though I guess the anchors should stay the same. I don't really care about the format as long as it works :) 09:24:24
@alejandrosame:matrix.orgalejandrosame
In reply to @asymmetric:matrix.dapp.org.uk

Can't run nix.dev devmode:

āÆ nix-shell --run devmode
error:
       … while calling the 'import' builtin

         at «string»:1:2:

            1| (import <nixpkgs> {}).bashInteractive
             |  ^

       … while calling the 'findFile' builtin

         at «string»:1:9:

            1| (import <nixpkgs> {}).bashInteractive
             |         ^

       error: file 'nixpkgs' was not found in the Nix search path (add it using $NIX_PATH or -I)

       at «none»:0: (source not available)
will use bash from your environment
Doing an initial build of the docs...
I think my new PR fixes this completely. At least it does handle properly the syntax error you mention in your issue :)
14:53:20
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @johannes.kirschbauer:scs.ems.host

It might be personal thing... I don't like those achor tags in our nix code because strictly bind our lib documentation to the current manual rendering, with those exact achor tags. Changing something in rendering (e.g. splitting in multiple pages) now means also breaking the documentation.

See [`lib.lists.foldl'`](#function-library-lib.lists.foldl-prime) but for attribute sets.

Has this been discussed in the documentation team? I'd prefer to keep the actual content un-opinionated from our rendering framework, and place neutral references, that are autoresolved instead of hard links, which break when touching the thing.

We haven’t discussed this, but someone recently made me aware of https://github.com/stepchowfun/tagref

I think it’s a nice idea, and seems like it would scale better than the reference system Sphinx uses (which in its MyST incarnation can’t discern between file paths and references… it produces a lot of busywork).

15:11:39
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @alejandrosame:matrix.org
I think my new PR fixes this completely. At least it does handle properly the syntax error you mention in your issue :)
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.
15:13:28
@alejandrosame:matrix.orgalejandrosame
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.
Where is NIX_PATH set? I don't follow.
15:25:11
@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

Show newer messages


Back to Room ListRoom Version: 6