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

[Daniel Narvaez]

Yes, I never got to write the GCI task :(

On Tuesday, 3 December 2013, Walter Bender wrote:

> On Tue, Dec 3, 2013 at 2:52 PM, Gonzalo Odiard <gonzalo at laptop.org<javascript:;>>
> wrote:
> > Ohh, is so nice...
> >
> > What should we do to have something similar on python api?
> >
> > Gonzalo
> >
> >
> > On Tue, Dec 3, 2013 at 4:31 PM, Manuel Quiñones <manuq at laptop.org>
> wrote:
> >>
> >> Right, is as Daniel said.
> >>
> >> You can look at the docs side-by-side with the code in
> >> developer.sugarlabs.org
> >>
> >> For example:
> >>
> >>
> >>
> http://developer.sugarlabs.org/sugar-web/graphics/radiobuttonsgroup.js.html
> >>
> >> 2013/11/27 Rogelio Mita <rogeliomita at activitycentral.com>:
> >> > 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 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
> >> >>
> >> >>
> >> >>
> >> >> --
> >> >> Daniel Narvaez
> >> >>
> >> >
> >> >
> >> >
> >> > --
> >> > Roger
> >> >
> >> > Activity Central
> >>
> >>
> >>
> >> --
> >> .. manuq ..
> >> _______________________________________________
> >> Sugar-devel mailing list
> >> Sugar-devel at lists.sugarlabs.org
> >> http://lists.sugarlabs.org/listi<http://lists.sugarlabs.org/listinfo/sugar-devel>GCI
> task(s)?
>
> -walter
>
> --
> Walter Bender
> Sugar Labs
> http://www.sugarlabs.org
>


-- 
Daniel Narvaez
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.sugarlabs.org/archive/sugar-devel/attachments/20131204/e54428d2/attachment.html>