Hi, it's been a while since I posted here in the community (or done much with 
Nim), but here at least is my $0.02:

I'm not a big fan right now of how inline documentation comments/strings work.

  1. This may be more of a personal preference, but I don't like putting the 
documentation right in the body of the function. It looks like this was 
influenced from Python. Java, C#, C/C++ doc systems (e.g. Doxygen), Rust, 
Swift, PHP; only to name a few of the major languages out there, put their 
doc-strings right above function, not in it.
  2. I would rather see a tool like Doxygen be used to generate the 
documentation for Nim. It's very mature, flexible, and generates easy to use 
docs. One other thing is that Doxygen generated docs typically are quite 
navigable. I find it a little hard to search through Nim's documentation a the 
moment. I'm not sure about the difficulty integrating the Nim language into 
Doxygen though


Reply via email to