<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!DOCTYPE bugzilla SYSTEM "https://www.w3.org/Bugs/Public/page.cgi?id=bugzilla.dtd">

<bugzilla version="5.0.4"
          urlbase="https://www.w3.org/Bugs/Public/"
          
          maintainer="sysbot+bugzilla@w3.org"
>

    <bug>
          <bug_id>9738</bug_id>
          
          <creation_ts>2010-05-14 22:01:34 +0000</creation_ts>
          <short_desc>Improve IDL documentation</short_desc>
          <delta_ts>2011-08-19 23:51:32 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>1</classification_id>
          <classification>Unclassified</classification>
          <product>WebAppsWG</product>
          <component>Indexed Database API</component>
          <version>unspecified</version>
          <rep_platform>All</rep_platform>
          <op_sys>All</op_sys>
          <bug_status>RESOLVED</bug_status>
          <resolution>FIXED</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard></status_whiteboard>
          <keywords>editorial</keywords>
          <priority>P2</priority>
          <bug_severity>minor</bug_severity>
          <target_milestone>---</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Nikunj Mehta">nikunj.mehta</reporter>
          <assigned_to name="Eliot Graff">eliotgra</assigned_to>
          <cc>jorlow</cc>
    
    <cc>mike</cc>
    
    <cc>public-webapps</cc>
          
          <qa_contact>public-webapps-bugzilla</qa_contact>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>35707</commentid>
    <comment_count>0</comment_count>
    <who name="Nikunj Mehta">nikunj.mehta</who>
    <bug_when>2010-05-14 22:01:34 +0000</bug_when>
    <thetext>1. Use Complete sentences.
2. Sequence constraints before attributes before methods.
3. Change &quot;On getting ...&quot; sentences to match the style in http://dev.w3.org/html5/spec-author-view/urls.html#reflecting-content-attributes-in-idl-attributes</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>55518</commentid>
    <comment_count>1</comment_count>
    <who name="Eliot Graff">eliotgra</who>
    <bug_when>2011-08-19 23:51:32 +0000</bug_when>
    <thetext>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 &quot;The cursor&apos;s required direction&quot; 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 &quot;on getting&quot; are clear and in a consistent style.

I am therefore going to resolve this bug as fixed.

Thanks so very much,

Eliot</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>