!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

415 Members
Discussion about documentation improvements around the Nix ecosystem80 Servers

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


SenderMessageTime
13 Jan 2024
@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
@bzzm3r:matrix.org@bzzm3r:matrix.org
In reply to @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              
```

Ah, I think I see. Okay, so this is presumably also where we put type information? (does "lambda formal" have a more specific meaning outside of nix/nixos?)
09:14:40

Show newer messages


Back to Room ListRoom Version: 6