Looking at 
[https://docs.python.org/3/library/string.html](https://docs.python.org/3/library/string.html)
 I don't see too many things wrong with Nim's documentation. Yes you can ignore 
stuff in `{. .}` (and we should hide it). On the other hand, at least every 
parameter has its type listed (unlike Python's docs). A separate page for every 
single proc would be total overkill and only encourages documentation like:
    
    
    proc foo(bar: Bar): Baz
       ## foo a bar.
       ##
       ## Parameters:
       ## bar   the Bar.
       ##
       ## Returns:
       ##   a Baz.

Which is the ultimate waste of time, wasting writers' and readers' time.

Having dealt with C#'s documentation extensively, it often doesn't mention 
crucial edge cases and examples and instead focusses on the obvious. I really 
like to avoid that. It doesn't mean that Nim is not for newbies, it means 
newbies need at least to be able to read Nim proc headers.

Having said that, we should really expand the pragma annotations only after a 
mouse click. Should be easy to do, PRs welcome. :) 

Reply via email to