W3C home > Mailing lists > Public > public-linked-json@w3.org > February 2013

Re: Another alternate version of the JSON-LD API spec

From: David I. Lehn <dil@lehn.org>
Date: Mon, 4 Feb 2013 16:58:48 -0500
Message-ID: <CADcbRRMDkNp2SeBmXP_XA7+7SQG4564RMmR=AOUhm6LXOY+Rwg@mail.gmail.com>
To: Dave Longley <dlongley@digitalbazaar.com>, "public-linked-json@w3.org" <public-linked-json@w3.org>
On Feb 4, 2013, at 9:55 AM, Dave Longley <dlongley@digitalbazaar.com> wrote:
> I've added a rough draft of the alternate version of the JSON-LD API spec I've been working on to the json-ld.org repository on github.
>
> It can be viewed here: http://json-ld.org/spec/latest/json-ld-api/alternate2.html
>

I agree with what Gregg has said and was about to make some similar
comments.  Here are a few other items:

Introduction
Text indicates doc is for authors and developers that want details or
for implementors.  This is leaving out the common case of regular API
users.  Perhaps the Introduction should link to the Algorithms section
and say it's for details and implementors and link to the API section
and say it's for regular use.

Features
The features link to the associated algorithms and perhaps should also
link to the APIs.

Examples
The Compaction text mentions compacting numbers.  Do we want to
increase example complexity to show off features like this?  Its a
general issue for all examples.  There are many use cases that would
be informative but are only living in test cases right now.

-dave
Received on Monday, 4 February 2013 21:59:15 GMT

This archive was generated by hypermail 2.3.1 : Tuesday, 26 March 2013 16:25:39 GMT