Re:Help us collect modern Python NumPy code solutions
by na85 on Monday March 28, 2022 @05:38PM
(#30835941)
The worst is when some project or library is extolled as being extensively documented and you find out it's just doxygen autogens.
Awful.
Re:Help us collect modern Python NumPy code solutions
by muggermuch on Monday March 28, 2022 @02:21PM
(#30833765)
+1 absolutely - it's been one of my pet peeves. There really needs to be some thought put into "doc UX".
Why do so few libraries seem to understand that good documentation starts by providing meaningful examples of simple tasks with semantic labels that can be found via search? Reference-style documentation assumes that you already know the name of the thing you're looking for (you don't), or that you have time to read for several days and build up an entire mental model of the system in one go before getting anything productive done (also no).