[16:13] <kandarpk> dfarning: around ?
[16:15] <bernie> kandarpk: he went out to buy something
[16:15] <bernie> kandarpk: 'morning, btw
[16:15] <kandarpk> bernie: good morning
[16:15] <kandarpk> bernie: can you please provide some links to study the functionality of various modules in sugar
[16:16] <bernie> kandarpk: hmm... let me think
[16:17] <bernie> kandarpk: this is the starting point of all sugar developer documentation: http://wiki.sugarlabs.org/go/Development_Team/Resources
[16:18] <bernie> kandarpk: this is a comprehensive guide to create sugar activities: http://en.flossmanuals.net/Sugar/Overview
[16:18] <bernie> kandarpk: activities use sugar-toolkit, which is one of the modules of sugar. the easiest one to learn
[16:21] <kandarpk> bernie: right now I was looking for some understanding of the modules inside sugar for their documentation
[16:21] <kandarpk> bernie: can you suggest which one should be the easiest to start with ?
[16:22] <bernie> kandarpk: sugar is the central one. I suggest not to dig into sugar-base and sugar-datastore until you must for some reason.
[16:23] <kandarpk> bernie: Ok.
[16:23] <bernie> kandarpk: actually, the only module that needs to be documented is sugar-toolkit
[16:23] <bernie> kandarpk: all the rest is internal stuff used only by core developers
[16:23] <bernie> kandarpk: whoever hacks on those will read the code, not external documentation
[16:24] <kandarpk> bernie: where will I be able to find the documentation of other modules ?
[16:24] <bernie> kandarpk: but sugar-toolkit is an API used by activity programmers, hence it needs to be clearly documented for someone who is not familiar with sugar internals
[16:24] <manusheel> bernie: Sure. Thank you for the starting point.
[16:24] <manusheel> bernie: Appreciate it.
[16:25] <kandarpk> bernie: Ok.
[16:26] <manusheel> bernie: We'll start with sugar-toolkit. Although, we do need to get into sugar-datastore and other modules. We received documentation requests on them. Also, it is important for Kandarp to understand these areas in USR too.
[16:27] <kandarpk> manusheel sir: how do I proceed ?
[16:27] <bernie> kandarpk: if you have never created an activity before, I would recommend reading the floss manual and maybe trying to create one of the demo projects yourself
[16:28] <bernie> kandarpk: so you get familiar with sugar-toolkit from the point of view of an activity developer
[16:28] <bernie> kandarpk: which is the point of view that the documentation will have to be written for
[16:28] <bernie> manusheel: k
[16:29] <kandarpk> bernie: please see http://api.sugarlabs.org/sphinx/
[16:29] <bernie> kandarpk: oops, the floss manual I quoted was the wrong one. this is the manual on creating activities: http://en.flossmanuals.net/ActivitiesGuideSugar/Introduction
[16:29] <kandarpk> bernie: this is what we started with.
[16:30] <kandarpk> bernie: Ok, thank. I'll go through the manual and will try creating activities for sugar.
[16:30] <manusheel> kandarpk: I'll send you the sample code of Hello world activity packaged as an xo file.
[16:30] <manusheel> Will help.
[16:31] <manusheel> kandarpk: However, let us keep our focus on what Tomeu and Bernie have suggested.
[16:31] <kandarpk> manusheel sir: Ok sir.
[16:32] <kandarpk> manusheel sir: I believe what Tomeu suggested will come with practice.
[16:32] <manusheel> kandarpk: Thanks. Kindly get back to me on the e-mail, which I had send you today. Sure, Kandarp.
[16:32] <manusheel> Absolutely.
[16:34] <kandarpk> manusheel sir: please see http://wave-robot-python-client.googlecode.com/svn/trunk/pydocs/index.html
[16:34] <manusheel> kandarpk: Ok.
[16:35] <manusheel> kandarpk: Yes, that looks better.
[16:35] <manusheel> kandarpk: Please make sure that we are not missing on any PEP 257 standard.
[16:50] <bernie> manusheel: as they're doing documentation, it might be good to encourage cleaning up the documentation in the wiki too. it's full of obsolete, redundant or even incorrect information
[16:51] <bernie> manusheel: I would recommend applying the Be Bold mantra of the Wikipedia: when in doubt, edit. Someone else will revert your edit if you were wrong.
[16:51] <bernie> kandarpk:  (since you were offline): as you're working on documentation, it might be good to also clean up the documentation in the wiki. it's full of obsolete, redundant or even incorrect information
[16:52] <bernie> kandarpk:  I would recommend adopting the Be Bold mantra of the Wikipedia: when in doubt, edit. Someone else will revert your edit in case you were wrong.
[16:54] <kandarpk> bernie: Ok. If I find anything like that I'll also report it on the mailing list to get the correct info.
[16:55] <dfarning> kandarpk, do you now have a plan to move forward?  Creating an activity is a good first step in seeing how the pieces fit together.
[16:56] <bernie> dfarning: yup, agreed
[16:56] <kandarpk> dfarning: need help.
[16:56] <bernie> kandarpk: the Hello World activity is a good starting point. or follow the floss manual tutorial
[16:56] <bernie> kandarpk: useful documentation on getting started: http://wiki.sugarlabs.org/go/Activity_Team/Resources
[16:57] <bernie> kandarpk: the Hello World activity is linked in the page above
[17:14] <bernie> kandarpk: I suggest you also hang out on #sugar since you'll be working closely with the sugar developers to document their coder
[17:14] <bernie> *code
[17:14] <dfarning> kandarpk,  I would suggest that you start by going though the flossmanual to which bernie linked and then create a simple activity.  Right now it seems like you are overwhelmed by the mass of undocumented (and in my opinon) poorly named code
[17:15] <kandarpk> bernie, dfarning: Ok, thanks.
[17:16] <bernie> dfarning: yup
[17:16] <bernie> dfarning: class names are also confusing, yes. alsroot can help make sense of them
[17:17] <dfarning> kandarpk, It will take some time but it will be time well spent.  The purpose of documentation is to answer the questions that begineers face when working with the code.  The problem with documentation is that once hackers understand a section of code they have no personal interest in documenting anymore:(
[17:19] <kandarpk> dfarning: I am having some problem in figuring out what all needs to be documented/what modules are there in sugar
[17:21] <manusheel> kandarpk: Let us go over the problems one by one.
[17:22] <dfarning> kandarpk, +1 that is why we are suggesting creating an activity.  While creating your test activity, every time you scratch you head and say, "I wonder how this works"  That is something that should be documented:)
[17:22] <kandarpk> manusheel sir: Ok, I'll start with creating an activity for sugar then.
[17:22] <manusheel> bernie: Sure. We'll clean up the documentation in wikipedia too.
[17:22] <kandarpk> dfarning: sure.
[17:22] <manusheel> kandarpk: Ok. That shouldn't take you more than 1 hour.
[17:22] <manusheel> Pretty simple.
[17:23] <manusheel> Start with hello world activity.
[17:23] <kandarpk> manusheel sir: I was browsing through various documentations prepared using sphinx to get to know how they are prepared
[17:24] <dfarning> manusheel, the current documentation really sucks:( I would estimate that it will take closer to 20 hours to create a working activity that uses several of the sugar specific features.
[17:25] <manusheel> dfarning: Thanks for the pointer, David. Who wrote that documentation?
[17:26] <dfarning> manusheel, whoever had a spare minute and a desire to write some documetation.
[17:27] <manusheel> dfarning: Ok :-)
[17:38] <bernie> manusheel, dfarning: the docstrings and wiki pages really are crap, but the floss manual by James Simmons is a fantastic guide introducing to almost every aspect of activity development
[17:45] <manusheel> bernie: Great. Thanks for the feedback.  Glad to hear James has written a neat guide.
[18:18] <bernie> manusheel: it's here: http://en.flossmanuals.net/ActivitiesGuideSugar
[18:18] <bernie> manusheel: david told me that this flossmanual is being used as textbook at RIT
[18:27] <manusheel> bernie: Ok. That is great to hear.