aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/rl-next/repl-doc-command.md
blob: 84aaa08024903eee3654c6e5bf2b198637dd08da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
---
synopsis: Experimental REPL support for documentation comments using `:doc`
cls: 564
---

Using `:doc` in the REPL now supports showing documentation comments when defined on a function.

Previously this was only able to document builtins, however it now will show comments defined on a lambda as well.

This support is experimental and relies on an embedded version of [nix-doc](https://github.com/lf-/nix-doc).

The logic also supports limited Markdown formatting of doccomments and should easily support any [RFC 145](https://github.com/NixOS/rfcs/blob/master/rfcs/0145-doc-strings.md)
compatible documentation comments in addition to simple commented documentation.