<br><br><div class="gmail_quote">On Thu, Aug 16, 2012 at 3:52 PM, Bruno Oliveira <span dir="ltr"><<a href="mailto:bruno@abstractj.org" target="_blank">bruno@abstractj.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div>
+1 for 'remove' instead of 'del'
</div><div><br></div><div>Something like this for documentation might be useful <a href="http://docs.emberjs.com/" target="_blank">http://docs.emberjs.com/</a></div></blockquote><div><br></div><div><br></div>
<div><br></div><div>that uses <a href="http://code.google.com/p/jsdoc-toolkit/">http://code.google.com/p/jsdoc-toolkit/</a> as well :))</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<span class="HOEnZb"><font color="#888888"><div><br></div><div><div><div>-- </div><div>"The measure of a man is what he does with power" - Plato</div><div>-</div><div>@abstractj</div><div>-</div><div>Volenti Nihil Difficile</div>
</div></div></font></span><div class="HOEnZb"><div class="h5">
<p style="color:#a0a0a8">On Thursday, August 16, 2012 at 9:57 AM, Matthias Wessendorf wrote:</p>
<blockquote type="cite" style="border-left-style:solid;border-width:1px;margin-left:0px;padding-left:10px">
<span><div><div><div>On Thu, Aug 16, 2012 at 2:43 PM, Kris Borchers <<a href="mailto:kris@redhat.com" target="_blank">kris@redhat.com</a>> wrote:</div><blockquote type="cite"><div><div>Thanks for the feedback! See responses inline.</div>
<div><br></div><div>On Aug 16, 2012, at 4:33 AM, Matthias Wessendorf <<a href="mailto:matzew@apache.org" target="_blank">matzew@apache.org</a>> wrote:</div><div><br></div><div>Hi,</div><div><br></div><div>looking at [1] and also reading the client JS code from the TODO app</div>
<div>(->app.js), I am wondering if there is a newer version of the draft?</div><div><br></div><div><br></div><div>This is more up to date but also needs some updating.</div><div><a href="https://github.com/aerogear/aerogear-js/blob/master/src/pipeline/README.md" target="_blank">https://github.com/aerogear/aerogear-js/blob/master/src/pipeline/README.md</a></div>
</div></blockquote><div><br></div><div><br></div><div>Ah... good to have some well hidden documents :-P</div><div><br></div><div><br></div><div><br></div><div><br></div><blockquote type="cite"><div><div><br></div><div><br>
</div><div>Also, inside of the rest adapter of aerogear.js the 'delete' function</div><div>is called 'del' ([2]), not sure if that's a good idea..</div><div><br></div><div><br></div><div>I was using delete but that is a reserved word in JavaScript so linters hate</div>
<div>it. I decided to change to del but we can change it to remove or something</div><div>else. I am open to suggestions.</div></div></blockquote><div><br></div><div>I know :-) but 'del' is a bit _awful_, IMO. why not remove, for now?</div>
<div><br></div><div><br></div><blockquote type="cite"><div><div><br></div><div><br></div><div>While reading the app.js file, I also noticed that some of the 'setup'</div><div>syntax needs to be documented (e.g. the draft is missing details on</div>
<div>settings,url etc of the cfg object):</div><div>var todo = aerogear.pipeline([</div><div> {</div><div> name: "tasks",</div><div> settings: {</div><div> url: "/todo-server/task"</div>
<div> }</div><div> },</div><div>...</div><div><br></div><div>Also - perhaps for now it is OK, but I think it (still) reads a bit</div><div>too much jQuery/ajax like?!</div><div>projectGet = Projects.read({</div>
<div> ajax: {</div><div> success: function( data, textStatus, jqXHR ) {</div><div> $( "#project-loader" ).hide();</div><div> updateProjectList( data );</div><div> }</div><div> }</div>
<div>});</div><div>(I think we had this topic already in the past, not too strong</div><div>feelings about this... but just wanted to mention this)</div><div><br></div><div><br></div><div>The reason there isn't documentation and that it looks like jQuery.ajax is</div>
<div>because it is. :) The ajax settings are basically a straight passthrough to</div><div>jQuery ajax so that any of those settings can be overridden. We can discuss</div><div>changing this but I figured why hide the fact that we're using jQuery.ajax</div>
<div>or add another layer of complexity over the already large list of settings</div><div>that can be changed on jQuery.ajax</div></div></blockquote><div><br></div><div>fair enough, but I think with different _transport_ (read websocket or</div>
<div>OData), we will see room for improvement.</div><div>But not that of a big deal, right now;</div><div><br></div><div><br></div><blockquote type="cite"><div><div><br></div><div>Oh, one last question, is there a decent/easy way to generate API docs</div>
<div>out of the JavaScript API?</div><div><br></div><div><br></div><div>I have not found one that I like. Most solutions require adding a bunch of</div><div>garbage to the source which I am not a fan of because it makes the source</div>
<div>itself harder to read. That being said, I am also not a fan of maintaining</div><div>that documentation by hand so hoping I can find some middle ground. Again,</div><div>open to suggestions.</div></div></blockquote><div>
<br></div><div>Yeah, but we need for all the clients (e.g. Android, iOS and JS) some</div><div>way to generate api docs.</div><div><br></div><div>In previous jobs I've used this:</div><div><a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">http://code.google.com/p/jsdoc-toolkit/</a></div>
<div><br></div><div>we can evaluate a certain tool at a later point, just wanted to ensure</div><div>we actually do something there :-)</div><div><br></div><blockquote type="cite"><div><div><br></div><div><br></div><div>Thanks!</div>
<div><br></div><div>[1] <a href="https://gist.github.com/3084134" target="_blank">https://gist.github.com/3084134</a></div><div>[2]</div><div><a href="https://github.com/aerogear/aerogear-js/blob/master/src/pipeline/adapters/rest.js#L74" target="_blank">https://github.com/aerogear/aerogear-js/blob/master/src/pipeline/adapters/rest.js#L74</a></div>
<div><br></div><div>--</div><div>Matthias Wessendorf</div><div><br></div><div>blog: <a href="http://matthiaswessendorf.wordpress.com" target="_blank">http://matthiaswessendorf.wordpress.com</a>/</div><div>sessions: <a href="http://www.slideshare.net/mwessendorf" target="_blank">http://www.slideshare.net/mwessendorf</a></div>
<div>twitter: <a href="http://twitter.com/mwessendorf" target="_blank">http://twitter.com/mwessendorf</a></div><div>_______________________________________________</div><div>aerogear-dev mailing list</div><div><a href="mailto:aerogear-dev@lists.jboss.org" target="_blank">aerogear-dev@lists.jboss.org</a></div>
<div><a href="https://lists.jboss.org/mailman/listinfo/aerogear-dev" target="_blank">https://lists.jboss.org/mailman/listinfo/aerogear-dev</a></div></div></blockquote><div><br></div><div><br></div><div><br></div><div>-- </div>
<div>Matthias Wessendorf</div><div><br></div><div>blog: <a href="http://matthiaswessendorf.wordpress.com" target="_blank">http://matthiaswessendorf.wordpress.com</a>/</div><div>sessions: <a href="http://www.slideshare.net/mwessendorf" target="_blank">http://www.slideshare.net/mwessendorf</a></div>
<div>twitter: <a href="http://twitter.com/mwessendorf" target="_blank">http://twitter.com/mwessendorf</a></div><div>_______________________________________________</div><div>aerogear-dev mailing list</div><div><a href="mailto:aerogear-dev@lists.jboss.org" target="_blank">aerogear-dev@lists.jboss.org</a></div>
<div><a href="https://lists.jboss.org/mailman/listinfo/aerogear-dev" target="_blank">https://lists.jboss.org/mailman/listinfo/aerogear-dev</a></div></div></div></span>
</blockquote>
<div>
<br>
</div>
</div></div></blockquote></div><br><br clear="all"><div><br></div>-- <br>Matthias Wessendorf <br><br>blog: <a href="http://matthiaswessendorf.wordpress.com/" target="_blank">http://matthiaswessendorf.wordpress.com/</a><br>
sessions: <a href="http://www.slideshare.net/mwessendorf" target="_blank">http://www.slideshare.net/mwessendorf</a><br>twitter: <a href="http://twitter.com/mwessendorf" target="_blank">http://twitter.com/mwessendorf</a><br>