#6560 NORM Never A: Docstring in sugar-activity.activity.Activity.read_file needs more on metadata

[Zarro Boogs per Child]

#6560: Docstring in sugar-activity.activity.Activity.read_file needs more on
metadata
--------------------+-------------------------------------------------------
 Reporter:  homunq  |       Owner:  marco         
     Type:  defect  |      Status:  new           
 Priority:  normal  |   Milestone:  Never Assigned
Component:  sugar   |     Version:                
 Keywords:          |    Verified:  0             
 Blocking:          |   Blockedby:                
--------------------+-------------------------------------------------------
 since this is explicitly a documented module, this is meaningful.

 Apparently the metadata comes hidden in self.metadata. Proposed docstring
 text:

 """Although not required, this is also a good time to read all meta-data:

         the file itself cannot be changed externally, but the title,
 description

         and other metadata['tags'] may change. So if it is important for
 you to

         notice changes, this is the time to record the originals.
 They

         are present in self.metadata when this function is called."""

 also, for write_file: talk about setting self._jobject and about the
 difference (?) between self._jobject.metadata and self.metadata.

-- 
Ticket URL: <http://dev.laptop.org/ticket/6560>
One Laptop Per Child <http://dev.laptop.org>
OLPC bug tracking system