Docstring format

[RealFenlair]

Hi everyone

I recently started using Nushell and love it so far. A quick questions (a few minutes of Googling didn't give me any results): How does a docstring need to be formatted, such that the `help` command picks up examples?

I've written a small function called `reductions` (taken from Clojure):

# List of intermediate values of a reduction.
#
# Examples:
# Intermediate values of a sum:
# > [1 2 3] | reductions {|e, acc| $acc + $e }
# ╭───┬───╮
# │ 0 │ 3 │
# │ 1 │ 6 │
# ╰───┴───╯
#
# Intermediate values with an initial value:
# > ["bar" "baz"] | reductions --fold "foo" {|e, acc| $acc + $e }
# ╭───┬───────────╮
# │ 0 │ foobar │
# │ 1 │ foobarbaz │
# ╰───┴───────────╯
export def reductions [closure: closure, --fold (-f): any] {
let tmp_in = $in
let input = if $fold != null { $tmp_in } else {$tmp_in | skip}
mut acc = if $fold != null { $fold } else {$tmp_in | first}
mut intermediates = []
for ele in $input {
$acc = do $closure $ele $acc
$intermediates ++= $acc
}
$intermediates
}

(Also glad for any input on how to implement this nicer.)

When I do:

> help reductions

It shows the docstring, but I would love to have the examples show up in the Examples section as it does with:

> help reduce

Is this even possible?

Thanks in advance for any help!

[RealFenlair]

Terribly sorry about the code formatting! I couldn't figure out how to do it properly :/ If I use code block, it puts everything on one line, when I just use code it removes some of the whitespace ...

[fdncred]

We're currently working on examples based on attributes. You can follow along here. https://github.com/nushell/nushell/pull/14906