I'm coming round to the view that optimum documentation is one web page per function.
This gives you space for prose, examples, related functions, version history and even user comments!
It's not the norm though, and requires substantial content writing.
miniblog.
Related Posts
44
I'm experimenting with syntax in examples. I don't really like Rust's `assert(inc(1) == 2)` syntax, I find it a little distracting.
I'm trying `inc(1) //-> 2`. The comment is rendered differently, and there's nothing before the sample code. What do you think?
Go has an elegant approach to defining example functions, which are shown in docs as `main()` with the output:
Some delightful examples of good compiler error messages in the latest Gleam release: