-
Notifications
You must be signed in to change notification settings - Fork 136
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Implement JSDocs #222
Comments
Yeah I agree. I don't know what we'll do for all the functions that are already there though. |
I'm not sure about having forced documentation. I feel like it would take out the fun of it for many of the joke functions, which anything.js has a lot of. I would prefer optional documentation - some functions are more 'serious' and in that case documentation would be suitable. |
You can always put off merging pull requests that lack proper commenting until the contributor adds them. Especially if the contribution is large and / or complex. A good first step would be adding a rule about commenting code to the contributing guidelines. |
My opinion is simple: we shouldn't reject code without documentation. Having a rule that forces documentation would, in my opinion, violate the spirit of anything.js. |
I think for the time being I will add the ability to auto generate docs from available jsdocs but not force it on users. |
anything should be as organic as possible. It will "slowly" grow and evolve into and organized API. |
I think it would be cool to enable auto generated JSDocs. That way, the developers themselves could implement the doc of their functions if they want it. |
Pull request ready #240 |
done |
It would save a lot of time on documenting when you force to include JSdoc comments.
We do need to implement that and generate it onto the website.
The text was updated successfully, but these errors were encountered: