!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

435 Members
Discussion about documentation improvements around the Nix ecosystem90 Servers

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


SenderMessageTime
13 Jan 2024
@bzzm3r:matrix.org@bzzm3r:matrix.org *

But who does the work to ensure that the doc comments match up with the actual code?

Also, it seems the doc comments RFC left defining how function arguments ought to be recorded in doc strings as "future work"...wouldn't that also be necessary for stuff like noogle, or auto-gen docs?

09:10:51
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host

bzm3r: > Also, it seems the doc comments RFC left defining how function arguments ought to be recorded in doc strings as "future work"...

I think this is might be common missunderstanding:

We specified it for "lambda-formals".

#### Lambda formals

```nix
/**Doc for the whole lambda function*/
{
 /**Doc for formal 'a'*/
 a
}:
 a              
```

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

bzm3r: > Also, it seems the doc comments RFC left defining how function arguments ought to be recorded in doc strings as "future work"...

I think this might be common missunderstanding:

We specified it for "lambda-formals".

#### Lambda formals

```nix
/**Doc for the whole lambda function*/
{
 /**Doc for formal 'a'*/
 a
}:
 a              
```

09:12:52
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host bzm3r: The rfc is not yet fully implemented. What currently works is all the stuff that you can right now see in noogle. 09:14:36

Show newer messages


Back to Room ListRoom Version: 6