#4358 NORM V1.1: patch: pydoc strings for sugar/lib/sugar/activity/activity.py

[Zarro Boogs per Child]

#4358: patch: pydoc strings for sugar/lib/sugar/activity/activity.py
---------------------+------------------------------------------------------
  Reporter:  pascal  |       Owner:  marco        
      Type:  defect  |      Status:  new          
  Priority:  normal  |   Milestone:  V1.1         
 Component:  sugar   |     Version:               
Resolution:          |    Keywords:  patch review+
  Verified:  0       |  
---------------------+------------------------------------------------------
Changes (by marco):

  * keywords:  patch review? => patch review+


Comment:

 {{{
 There are a number of standard Toolbars. The most basic one, the one
 your almost absolutely MUST have is the ActivityToolbar. Without
 this, you're not really making a proper Sugar Activity (which may be
 okay, but you should really stop and think about why not!) You do
 this with the ActivityToolbox(self) call in step 1.
 }}}

 The reason the API doesn't just create a toolbox containing an
 ActivityToolbar is that activities (games which always want the full of
 the screen for example) might want to provide their own way to access
 essential actions like Close. I think we need to adjust the wording there
 to reflect this (mostly remove the MUST).

 {{{
 The activity id is sort-of-like the unix process id (PID). However,
 unlike PIDs it is only different for each new instance (with
 create_jobject = True set) and stays the same everytime a user
 resumes an activity.
 }}}

 Please remove the create_object reference there. It's an horrible hack we
 need to get rid of asap. I'm not fully convinced about the parallel with
 process PID. The activity id is a unique identifier for an activity
 instance, used both locally when resuming from the journal, and remotely
 when sharing on the network.

 {{{
 Once the file has been opened, you do not have to read it immediately:
 After you have opened it, the file will only be really gone when you close
 it.
 }}}

 Huh, does the file actually get deleted if you do this? Something tells me
 that we don't want activity authors to rely on it anyway. Please just
 remove this for now, we can discuss it and add it with a separate patch if
 necessary. It feels more like an API issue to me :/

 Please check it in once the above issues are addressed. Nice work, thanks!

-- 
Ticket URL: <https://dev.laptop.org/ticket/4358#comment:5>
One Laptop Per Child <https://dev.laptop.org>
OLPC bug tracking system