!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

437 Members
Discussion about documentation improvements around the Nix ecosystem93 Servers

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


SenderMessageTime
12 Jan 2024
@raitobezarius:matrix.orgraitobezariusIt contains of course the hard work of pennae to find the edge cases and what not21:17:11
@raitobezarius:matrix.orgraitobezariusBut beyond that, it's a fairly mundane program21:17:17
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @raitobezarius:matrix.org
I know both codebases, I don't have deep familiarity with neither, but I can achieve deep familiarity with nrd in stupidly low amount of time
are you offering help? 🙃
21:17:51
@raitobezarius:matrix.orgraitobezariusNo, but I can be there if there's any rescue-level tasks regarding nrd or this sort of stuff21:18:17
@raitobezarius:matrix.orgraitobezariusI think it's better if someone else grow experience with nrd :)21:18:27
13 Jan 2024
@bzzm3r:matrix.org@bzzm3r:matrix.org How feasible are such "docs auto-generation" projects, given the lack of typing systems or other automated verification/compiler-based checks in Nix-the-language?00:32:30
@infinisil:matrix.orginfinisil At least nixdoc is used already for lib documentation. 00:33:43
@infinisil:matrix.orginfinisilTbh I gotta sleep though, good night!00:34:48
@bzzm3r:matrix.org@bzzm3r:matrix.orgOkay, and this is an important background RFC: https://github.com/NixOS/rfcs/blob/master/rfcs/0145-doc-strings.md00:44:48
@9999years:matrix.org@9999years:matrix.org
In reply to @infinisil:matrix.org
At least nixdoc is used already for lib documentation.

is there a plan to use nixdoc to document .override arguments/defaults, package doc comments, or function arguments?

# In `my-func/default.nix`
{ }: # ← callPackage arguments

/* I want this to render as documentation for `pkgs.my-func`
 */
{
/* I want this to render as documentation for `myArgument`
 */
myArgument
}:
null
00:55:48
@9999years:matrix.org@9999years:matrix.orgthere's lots of good comments in the nixpkgs source that aren't visible except by grepping and it would be great to get those rendered into reference docs00:56:10
@mcdonc:matrix.orgChris McDonough danielsidhion and bzm3r ... thank you for the PR review suggestions... I think all of them are incorporated except this one https://github.com/NixOS/nixpkgs/pull/277534/files#r1450744275 ... (heading name)... i rationalize why i think it's the right thing in a reply there 03:19:57
@bzzm3r:matrix.org@bzzm3r:matrix.orgRedacted or Malformed Event09:02:01
@bzzm3r:matrix.org@bzzm3r:matrix.org
In reply to @mcdonc:matrix.org
danielsidhion and bzm3r ... thank you for the PR review suggestions... I think all of them are incorporated except this one https://github.com/NixOS/nixpkgs/pull/277534/files#r1450744275 ... (heading name)... i rationalize why i think it's the right thing in a reply there
*

As I said in my review comments, this is looking really good, and if I had merge powers, I'd hit merge. But I also am not in touch with the details in a way that that infinisil or fricklerhandwerk might be, so it's a good thing I don't have merge powers.

Anyway I just want to say, as one new contributor to another, please don't feel frustrated by the fact that this is a process that will take time because both fricklerhandwerk and infinisil:

  • are time constrained
  • are careful, and therefore might have more requests for changes
  • are human

I would suggest putting it up as a point for discussion in the meeting agenda for next week. It tends to get sorted out super fast in these meetings, because of the communication setup.

In the meantime I found it helpful to move onto other projects/PRs. I think of PRs as seeds that I plant...

09:02:35

Show newer messages


Back to Room ListRoom Version: 6