Golo provides a support for documentation blocks on modules, functions, augmentations and structs.
Blocks are delimited by ---- and contain free-form Markdown
[10]
text.
Here is a quick example:
----
This is a *nice* module that does a bunch of useless things.
See more at [our website](http://www.typeunsafe.org).
----
module Hello
----
Adds 2 elements, which is quite surprising given the name.
* `x` is the first argument,
* `y` is the second argument.
The following snipped prints `3`:
let result = adder(1, 2)
println(result)
Impressive!
----
function adder = |x, y| -> x + y