This is an archived snapshot of W3C's public bugzilla bug tracker, decommissioned in April 2019. Please see the home page for more details.

Bug 9738 - Improve IDL documentation
Summary: Improve IDL documentation
Alias: None
Product: WebAppsWG
Classification: Unclassified
Component: Indexed Database API (show other bugs)
Version: unspecified
Hardware: All All
: P2 minor
Target Milestone: ---
Assignee: Eliot Graff
QA Contact: public-webapps-bugzilla
Keywords: editorial
Depends on:
Reported: 2010-05-14 22:01 UTC by Nikunj Mehta
Modified: 2011-08-19 23:51 UTC (History)
3 users (show)

See Also:


Description Nikunj Mehta 2010-05-14 22:01:34 UTC
1. Use Complete sentences.
2. Sequence constraints before attributes before methods.
3. Change "On getting ..." sentences to match the style in
Comment 1 Eliot Graff 2011-08-19 23:51:32 UTC
I believe that I finally have all of these covered. There are a few places in which phrases are used rather than complete sentences, but they are on purpose and appropriate, such as "The cursor's required direction" for the direction parameter of IDBIndex.openCursor(). Other than those, I believe the spec is, editorially speaking, in very good shape. the element order through the WebIDL is consistent, and the sentences describing "on getting" are clear and in a consistent style.

I am therefore going to resolve this bug as fixed.

Thanks so very much,