!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

436 Members
Discussion about documentation improvements around the Nix ecosystem93 Servers

Load older messages


SenderMessageTime
21 Jun 2023
@pennae:matrix.eno.spacepennae
In reply to @sternenseemann:systemli.org
pennae: you are working on nixdoc related dedocbookification now right? can you say what would be required for https://github.com/NixOS/nixpkgs/issues/126375 and when it would make sense to do it? I'd be interested to pick it up sometime again, but I figure it doesn't make sense while stuff is in flux
would say to wait until the nixpkgs manual is fully converted, which should hopefully be within the next few weeks. we'll try to make the functions doc bit as generic as we reasonably can while we're at it anyway
12:00:20
@sternenseemann:systemli.orgsternicool ty12:29:19
22 Jun 2023
@fricklerhandwerk:matrix.orgfricklerhandwerkIf we get through updates quickly today, I propose that we look into https://sovereigntechfund.de/en/challenges/ together. We still don't have NixOS and Nixpkgs manual maintainers, and possibly there are other problem domains that could benefit from a large one-time grant.06:47:45
@j-k:matrix.orgj-kAnother fund I've just became aware of https://ostif.org/13:07:09
@pennae:matrix.eno.spacepennae sterni: looked into this a bit more, making the function lib docs generic will be a bit more than just a drive-by refactoring. we'll need to extend tooling as well to avoid section id clashes for example 13:12:21
@pennae:matrix.eno.spacepennaeit does look totally possible, but not something we can easily fit into the docbook removal process13:12:54
@pennae:matrix.eno.spacepennae asymmetric: your snapshot tests unknowingly broke pattern argument formatting 😅 17:23:57
@asymmetric:matrix.dapp.org.ukasymmetricRedacted or Malformed Event17:43:42
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @pennae:matrix.eno.space
asymmetric: your snapshot tests unknowingly broke pattern argument formatting 😅
Lol wat, how? 😅
17:44:34
@pennae:matrix.eno.spacepennaeprint_indented broke17:44:56
@pennae:matrix.eno.spacepennaereplaced the whole thing with textwrap now, should be much better17:45:21
@pennae:matrix.eno.spacepennaealso for some reason the set of function nixdoc finds is different than when we started, not sure whether the rnix update is the reason or something else17:47:39
@pennae:matrix.eno.spacepennae the rnix update seems to also have lost a number of entries for libraries that use let ...; in { inherit ...; }, sigh 18:00:22
@pennae:matrix.eno.spacepennaethe nixdoc approach to finding docs is just ... wrong, really :/18:03:00
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @pennae:matrix.eno.space
the nixdoc approach to finding docs is just ... wrong, really :/
What would you suggest instead?
20:25:07
@pennae:matrix.eno.spacepennae short term, no alternative
long term, put docs awareness into nix as suggested by the docs syntax rfc
20:26:18
@pennae:matrix.eno.spacepennaelooks like we got it working again with mostly the same semantics as the old nixdoc, but it's very fragile :(20:29:22
@pennae:matrix.eno.spacepennaeit's not realistically possible to extract function docs from nix files without evaluating them, if it's not in nix itself there will always be confusing corner cases. we're not super hopeful that it'll end up being added to nix because the use case is disproportionately small compared to the cost of having that functionality. we may have to codify lib docs syntax somehow else instead20:35:41
23 Jun 2023
@fricklerhandwerk:matrix.orgfricklerhandwerkWhat about something naive like wrapping all library functions in attribute sets and exposing just the functions as well as that large collection of metadata?06:31:40
@fricklerhandwerk:matrix.orgfricklerhandwerk Also there still exists the ominous __functor 06:36:00
@sternenseemann:systemli.orgsterni
In reply to @pennae:matrix.eno.space
it does look totally possible, but not something we can easily fit into the docbook removal process
that’s fine but it probably only makes sense to do after that is finished
09:17:27
@sternenseemann:systemli.orgsterni
In reply to @pennae:matrix.eno.space
short term, no alternative
long term, put docs awareness into nix as suggested by the docs syntax rfc
that’s not a silber bullet as well
09:18:44
@sternenseemann:systemli.orgsterni
In reply to @fricklerhandwerk:matrix.org
What about something naive like wrapping all library functions in attribute sets and exposing just the functions as well as that large collection of metadata?
extra runtime overhead
09:19:28
@fricklerhandwerk:matrix.orgfricklerhandwerk sterni: what's your take on it then? 09:53:51
@pennae:matrix.eno.spacepennae
In reply to @sternenseemann:systemli.org
that’s not a silber bullet as well
it's closer to one than what we have now. if nix could optionally store and return, for each attribute or lambda arg, the doc comment that was attached to it we'd be golden for pretty much everything
13:33:02
@pennae:matrix.eno.spacepennaedoing so would cause overhead, but that can be mitigated sufficient to be just about free13:33:29
@pennae:matrix.eno.spacepennae nixdoc pr for nixpkgs manual dedocbookification is now done. we'll have to clean up the nixpkgs pr a lot before sending still
(cc asymmetric)
13:52:55
@pennae:matrix.eno.spacepennaeexcellent, the macos build failed for unrelated reasons :D14:07:43
@pennae:matrix.eno.spacepennaenixdoc should probably sort its output, shouldn't it18:29:48
24 Jun 2023
@pennae:matrix.eno.spacepennae zmitchell: with any luck your june in docs could still include docbook removal 21:49:37

Show newer messages


Back to Room ListRoom Version: 6