RE: API design sanity-testing and public-script-coord...

On Friday, April 26, 2013 9:53 PM, Marcos Caceres wrote:
> On Friday, April 26, 2013 at 10:40 AM, Charles McCathie Nevile wrote:
> 
> > Hi folks,
> >
> > on the public-script-coord list there has been a discussion about
> better
> > early review of APIs, and one of the upshots was a request that when
> a
> > group starts a new API, they send a pointer to that list. Ideally
> this
> > will enable review of the basic design patterns by more people who
> are
> > good at developing "javascript-style APIs", which would be helpful.
> >
> > Web Apps will do this,
> So will SysApp.
> > and I would strongly encourage other groups to do
> > it too. Having consistent design across all the APIs we offer
> developers
> > will help them to learn new ones easily and correctly, as well as
> make
> > sure that people who are writing third-party documentation don't get
> > caught out by unexpected differences.
> >
> > There is also a draft of a "design API cookbook" somewhere (Robin is
> cc'ed
> > to add a link ;) ) that could use some loving, to make it a useful
> > resource.
> 
> http://scriptlib-cg.github.io/api-design-cookbook/

That's a pretty outdated version. You should look at

http://darobin.github.io/api-design-cookbook/

instead.


Cheers,
Markus

--
Markus Lanthaler
@markuslanthaler

Received on Saturday, 27 April 2013 08:17:00 UTC