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
Start to document Javascript #2571
Conversation
sorry for the early post,tab space is not my friend. |
Change construcs to constructor to be recognized
more doc and add readme on how to build/view the doc |
Moving forward, still no review.. |
and here is how it looks like. default theme, can be changed. |
As this is only and purely docs, without objection i'll merge it tomorrow. |
A few comments:
|
I'm curious: what are the other node dependencies that you foresee? |
A few things: We are probably going to eventually want to start running jslint on our JS We also will want to combine/minimize our JS. We are going to start using Bootstrap and less and will want the ability to On Fri, Nov 30, 2012 at 9:49 AM, Jason Grout notifications@github.comwrote:
Brian E. Granger |
But, as you can see these will be requirements to develop the notebook, not On Fri, Nov 30, 2012 at 9:52 AM, Brian Granger ellisonbg@gmail.com wrote:
Brian E. Granger |
Short from my phone. Ok for merge?
|
I am not thrilled about this syntax, but I guess it is unavoidable. That On Fri, Nov 30, 2012 at 2:31 PM, Bussonnier Matthias <
Brian E. Granger |
Sorry about Do we add a static build somewhere on IPython website ? |
Start to document Javascript see IPython/frontend/html/notebook/static/js/readme on how to compile/see it.
Great, thanks for this work! |
Start to document Javascript see IPython/frontend/html/notebook/static/js/readme on how to compile/see it.
Ok,
I looked at documenting javascript.
The 2 main school are :
Or a mixed of the two.
I choose the first so that you could explicitely add things like
@deprecated
,@class
,@static
.Among those the difference in language is minimal. with most of the keywords in common and a few difference here and there like you to make crosslink.
lots of people like JsDoc and show it by forking it and adding incompatible option, so that v2 is almost 2 years old and has 4 implementation with different behavior. And the official one is deprecated.
v3 is "on it's way" with bugs like template not working. Exception about parsing command line after outputing half of the doc. Link in the doc not working.
But it is the one that require the less human work as it figures out itself if stuff are methods, static, ...Etc
The other good one I found was YUI doc, which more duplicate work (retype
@method methodname
for each methods), butwork out of the box. Is maintained. Has lots of users. Has good docs ! support markdown in comment. Works in general better.
So this is mostly targetting YUIdoc (http://yui.github.com/yuidoc/)
Comment starting with
/**
(2 stars) , keyword beginnig with@
, above each function.Does this suite everyone ?
Should we start forcing ourselves do document every JS function that we modify in this way ?
I'll add doc building with yuidoc on a separate PR.
(YIU doc docs are build with yui doc, if you want to see)