Hi all, my humble 2ct to the docu topic:

it took me also 1hr to find out what a Slice is and how it`s constructed and 
especially whats the difference between Slice and range (I think range is 
compiler built in). One example would be very nice.

@jzakiya you can also use printf native in Nim (I personally hate that because 
I did mostly embedded and nobody likes that there .

that a string is implemented as a sequence told me g**gle.

The coolest thing I recently discovered is that you can do a manual allocMem 
and let the gc do the dealloc (burried within this forum by an example of 
mratsim)

The docu is good (especially the FFI and Compiler User Guide); but the 
information is sometimes really scattered (some examples are in the manual, 
some inside the module (stdlib), some reside within the tutorial).

At least I found me browsing the sourcecode. The bugtracker in Git is also very 
good (if you need special information how something exotic was solved)

But for someone who comes from a interpreted language it´s hard and I agree 
it´s a little bit time consuming. At least for everything (if you use the C/Cpp 
backend) the cpp reference is your friend ( 
[http://en.cppreference.com/w](http://en.cppreference.com/w)/ ).

I know it´s very difficult to write good documentation especially for a 
language which has the power of nim (the best and easiest to use build system I 
ever worked with) no hazzle with cmake, make (magic folder naming rules; 
somethimes the build has more (crappy) complexity than the project itself), gcc 
and so on). There are so much topics to cover and nobody knows everything. It's 
also very hard to keep the docu up to date.

The docu from java was very good (especially pre 1.0) and there is/was least 
one example for everything.

Especially for a nim-noob like me (as a absolutely noob you have sometimes a 
unobstructed view) it would be nice to get into by helping with the 
documentation.

But for me (and I think others, too) it´s not very clear how to contribute (a 
howto would be very nice). Some docu (I think the manual) is inside the doc 
folder (rst, but how do you run the generator?), there is also a example folder 
and the other stuff is within the sourcecode generated with nim doc... so 
really scattered (and at the beginning very confusing).

And I sometimes found me also within the situation that I skipped over 
something important within the documentation :->

Reply via email to