diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/rl-next/repl-doc-command.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/manual/rl-next/repl-doc-command.md b/doc/manual/rl-next/repl-doc-command.md new file mode 100644 index 000000000..84aaa0802 --- /dev/null +++ b/doc/manual/rl-next/repl-doc-command.md @@ -0,0 +1,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. |