3 ms·
Newer? If you look at Javadocs, they're highly structured, at least as much as — and arguably more so than — Go docs. I think it has got more to do with cultur
by FooBarWidget 5y ago
Newer? If you look at Javadocs, they're highly structured, at least as much as — and arguably more so than — Go docs.
I think it has got more to do with culture and tradition. Each language seems to have its own documentation culture. Python seems to favor docs in which structure is interleaved with prose.
I find Go docs to be pretty hard to make sense of. Often times they don't explain very well how to use a package. And browsing around different aspects of a library carries a feeling of obscurity.
Ultimately, I think documentation should be split up into multiple categories, ala https://documentation.divio.com/ https://documentation.divio.com/