wroclaw-git-backups/nix
1
0
Fork 0
mirror of https://github.com/NixOS/nix synced 2025-06-25 06:31:14 +02:00
Code Activity

nix repl: Render docs for attributes

Browse source
This commit is contained in:
Robert Hensing 2024-07-09 19:25:45 +02:00
parent 491b9cf415
commit d4f576b0b2
10 changed files with 237 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/manual/rl-next/repl-doc-renders-doc-comments.md
View file

@ -45,7 +45,7 @@ Examples
```
Known limitations:
- It currently only works for functions. We plan to extend this to attributes, which may contain arbitrary values.
- It does not render documentation for "formals", such as `{ /** the value to return */ x, ... }: x`.
- Some extensions to markdown are not yet supported, as you can see in the example above.
We'd like to acknowledge Yingchi Long for proposing a proof of concept for this functionality in [#9054](https://github.com/NixOS/nix/pull/9054), as well as @sternenseemann and Johannes Kirschbauer for their contributions, proposals, and their work on [RFC 145].