[Sugar-devel] Web-activity: Store API documentation

[Rogelio Mita]

I will take note of this


2013/11/26 Daniel Narvaez <dwnarvaez at gmail.com>

> We didn't really write much API docs yet (bad us) but the idea is to use
> docker js.
>
> http://jbt.github.io/docker/src/docker.js.html
>
> In theory this should allow free form docs while keeping them inside the
> code, which is usually good to avoid them becoming stale.
>
> On Tuesday, 26 November 2013, Rogelio Mita wrote:
>
>> Hi!
>>
>> I was doing use of dictstore API on my POC web activity and I found in
>> the position to want do: "save data when closing activity", trying things
>> and reading source code I found this paragraph that helped me to do this
>> task:
>>
>>
>> https://github.com/sugarlabs/sugar-web/blob/master/activity/activity.js#L30
>>
>>> // An activity that handles 'activityStop' can also call
>>> // event.preventDefault() to prevent the close, and explicitly
>>> // call activity.close() after storing.
>>
>>
>> This information is very useful, my propose is start this thread to
>> discuss the way to documenting Storage API.
>> The first proposal/task:
>>
>>    - Make a section on http://developer.sugarlabs.org/ called "Storing
>>    information" or something like, and:
>>       - Migrate this comment<https://github.com/sugarlabs/sugar-web/blob/master/activity/activity.js#L30>to this doc page
>>       - Make a test or example that describe this situation: "Save when
>>       closing we activity"
>>    - Fetch comments similar to that on source code and do same flow
>>    - Make a introduction of "dictstore API" and document it
>>
>> Regards!
>>
>>
>> --
>> Roger
>>
>> Activity Central <http://activitycentral.com/>
>>
>
>
> --
> Daniel Narvaez
>
>


-- 
Roger

Activity Central <http://activitycentral.com/>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.sugarlabs.org/archive/sugar-devel/attachments/20131127/9e6f32af/attachment.html>