@dom96 > Doc writing is boring > > Creating documentation PRs is the easiest thing in the world (but also the > most boring)
It depends. I, for instance, quite like it. I care (although "deeply" may be a big word) about my users so even if I have no time, energy or I'd like to move to another project, I like to make good docs so that the project is... well... what I call "mature product". > So, what's your excuse? A few reasons not to do this: * It seems Araq doesn't really like my way of thinking. I can also see how Araq reacted to pointing out formatFloat's odd behaviour for 0 (which was quite odd to me, too). I, for instance, didn't notice it myself as I don't really use Nim for numerical calculations (I use Fortran). And I think good docs should be treated as kind of test and things should be fixed if these tests prove what they test is unobvious or even worse, erroneous. * I once made a pull request to a unofficial Nim package. It wasn't accepted because of... names of testing routines. Of course it's just an example, but if everybody says docs are not-really-so-important, boring and in-general-quite-of-stupid-thing-to-do-so-please-do-it and then it turns out that some real code can be simply ignored because of such a "stupid thing", then I'm not really surprised few people are motivated. * I, for once, am using Nim for just a few things. I could write some docs about using macros but I didn't even knew about formatFloat because... I've never used it. I think the authors of respective pieces of code are the best people to write docs as... they just know what these things do and why they decided them to do so. Also, if the docs are updated simultaneously with the code, they're always up-to-date. Then, some other people can improve the docs and, thanks to that, possibly improve the code too, as the docs help finding out the code's far from perfect. > Nim is a community project. Everybody that works on it, does so out of love > for the project. Telling us to "get on it" is unfair and rather ignorant. Then no surprise users have complains and may eventually switch to another language. Most of people don't like "shut up, I do it in my free time anyway". Or so I guess. @Araq Good to know. I haven't really tried generating comments yet as it's quite new (it wasn't there before I took a break from using Nim). Too bad it doesn't work for submodules. But I like renaming nim doc2 to nim doc. @mratsim > documentation is universally what most devs always put last That's bad news. But I like the idea of Nim Cookbook, that's for linking it.
