FWIW, I’d like to suggest R and the tidyverse in particular as a gold standard for documentation:
Every function has its usage, arguments (with types!!), and output (with types!!) and lots of examples. There are also ‘vignettes’, like tutorials, that give best practices.
I think it’s worth pointing out @Volker_Weissmann that the idea of ‘methods’ is a bit alien to a lot of ‘dynamic’ language users, so organising documentation by methods doesn’t make sense for Julia. I would also like to say that I think Rust’s documentation is some of the worst I’ve even seen. E.g.:
- How do I initialise a
Date
object? - How do I add two
Dates
together? - What is the underlying structure of the
Date
type? (Big shout out to R’sstr
and Julia’sdump
)
This is all there, I know, but it’s buried and very hard to read. I am sure that experienced Rust users/programmers who like the ‘OO’ style can navigate a page like this efficiently, but when I tried to learn Rust a couple of years ago it was like getting blood from a stone - no one would tell me how to do anything quickly!