Hi, I should add that the documentation on the wiki client section was good. I am guilty of looking at it too late after I had finished a lot of the work. Xavier sent me this link but for some reason I didn't take a close look today until I had mostly finished, whoops! That is entirely my fault. That info really makes up for the lack of comments in the actual code, and it would have made my life easier if I had seen it.
Here is my commit for Issue #159: https://gitorious.org/~chr15m/cardstories/cardstories-mccormix/commit/20f4b676513a582fb3761318a18f2d3af14714a9 I will speak to you again on Wednesday or Thursday. In the meantime I look forward to Loic's feedback on the patch. I hope what I did was correct. Cheers, Chris. On Mon, Jun 20, 2011 at 04:53:06PM +0200, david blanchard wrote: > Hi Chris, > > thanks a lot for the mail. > Regarding the #159, the easiest for you once you're done with it is to > pass it in the state "ready for review", so that Loic will know he needs > to review it. > > Thanks for the feedback about the code ! I'm ccing the mailing list so > that it's shared with the rest of the team and anyone can react on it. > > All the best > David > > On 06/20/2011 02:38 PM, Chris McCormick wrote: >> Hi David, >> >> Thanks for making contact. As per ticket #159, I have the methods (Loic >> calls them "switches") for the two new anonymous versions of "invitation" >> and "vote" written, and some placeholder HTML for that too. They seem to be >> working in the browser according to the specification that Loic wrote for me >> ("&anonymous=yes" in the query string). Now I am working on the unit tests. >> Once that is done I will commit the code and send an email to Loic for him >> to merge or give me feedback at his leisure. I hope that is what you expect, >> let me know if there is something else I should be doing. >> >> I have some small feedback on the code itself which I would like to forward >> to Loic and Xavier too. This is not meant as a criticism in any way, but >> more of a factual observation. The quantity of comments in the front-end >> code is very low: >> >> $ ohcount static/js/jquery.cardstories.js >> Examining 1 file(s) >> >> Ohloh Line Count Summary >> >> Language Files Code Comment Comment % Blank >> Total >> ---------------- ----- --------- --------- --------- --------- >> --------- >> javascript 1 774 37 4.6% 68 >> 879 >> ---------------- ----- --------- --------- --------- --------- >> --------- >> Total 1 774 37 4.6% 68 >> 879 >> >> The quality of those comments is also such that they are written more as >> small reminders to the original coder than they are as robust hints for >> someone new to the code. >> >> This makes it quite difficult for someone new to the code like myself to >> jump in and understand what is going on where. What would be immensely >> helpful for someone just joining like me is if each method (or "switch") >> could have a small comment saying what it's for, what it's context is, what >> goes in and what is expected to come out. As it was I eventually worked it >> out, I think, but it was more difficult than it needed to be. >> >> Cheers, >> >> Chris. >> ------------------- http://mccormick.cx _______________________________________________ Farsides mailing list - [email protected] Wiki: http://farsides.com/ List: http://farsides.com/ml/ Forum: http://farsides.com/forum/ Ideas: http://farsides.com/ideas/ Chat: http://farsides.com/chat/
