[w3c/IndexedDB] Add non-normative docs for APIs (#110)

Several specs ([Encoding](https://encoding.spec.whatwg.org/), [DOM](https://dom.spec.whatwg.org/), etc) have non-normative documentation for examples, something along the lines of:

> _store_ = _transaction_ . get( _name_ )
> > Gets an _IDBObjectStore_ object.
>
> _request_ = _store_ . add(_value_, _key)
> > Adds a record to the store with the specified key. Will fail if the a record with the same key is already present.
>
> _request_ = _store_ . put(_value_, _key)
> > Adds a record to the store with the specified key. Will overwrite a previous record with the same key.

... which saves developers from having to read spec-ese, especially as the behavior of the async methods is far away in the spec from the IDL entry points.

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/w3c/IndexedDB/issues/110

Received on Friday, 4 November 2016 22:30:18 UTC