Documentation!
Opened this issue · 2 comments
The vast majority of your code is very lacking in proper documentation, a vital resource for anyone wanting to contribute (or just read over) your code! Otherwise, nice work - your code is pretty good for your first mod!
I would like to say that's just because its not finished but even when it
is, don't expect a litterin of docs. Internal things are only documented
when it's not easy to work out what they do with a minute's code reading.
In my experience reading implementation details is more useful than docs
where possible
On Thursday, August 15, 2013, Toby wrote:
The vast majority of your code is very lacking in proper documentation, a
vital resource for anyone wanting to contribute (or just read over) your
code!—
Reply to this email directly or view it on GitHubhttps://github.com//issues/69
.