Skip to content
This repository has been archived by the owner on Apr 19, 2018. It is now read-only.

Code documentation style #55

Open
preip opened this issue Jun 28, 2014 · 6 comments
Open

Code documentation style #55

preip opened this issue Jun 28, 2014 · 6 comments

Comments

@preip
Copy link
Member

preip commented Jun 28, 2014

There is currently no preferred documentation style for the project, which might have to do with there currently being not much documentation. To fill this gap, I nominate YUIDoc to be our documentation style, which seems to be a popular way of documenting javascript code.

Links:
http://yui.github.io/yuidoc/
http://yui.github.io/yuidoc/syntax/index.html

If everybody agrees, or at least nobody is against that style, I would be happy to finally document my code. Writing all that weak typed code with no documentation is beginning to make me feel ill.

@kiliankoe
Copy link
Member

You've got my vote 👍

@preip
Copy link
Member Author

preip commented Jul 2, 2014

I guess, based on the scarce contributions, YUIDoc it is than. Soooo. doe's anybody feel inclined to maybe also document his code? Just a cautious question.

@preip preip added the question label Jul 2, 2014
@kiliankoe
Copy link
Member

Definitely have it on my todo list, maybe you can give a quick walkthrough in person? ;)

@preip
Copy link
Member Author

preip commented Jul 3, 2014

sure

@kiliankoe
Copy link
Member

I'll just leave this here.

not today

@preip
Copy link
Member Author

preip commented Jul 6, 2014

In my experience, this pretty much resembles reality.^^

@kiliankoe kiliankoe removed the question label Aug 7, 2014
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants