Re: [w3c/screen-orientation] Editorial: Edits to Interface Definitions (#130)

marcoscaceres requested changes on this pull request.

Couple of little suggestions and markup fixes... 

> @@ -151,29 +151,31 @@ <h2>
     </section>
     <section>
       <h2>
-        Interface definitions
-      </h2>
-      <section>
-        <h2>
-          Extensions to the <a>Screen</a> interface
-        </h2>The CSSOM View specification defines a <code>Screen</code>
-        interface [[!CSSOM-VIEW]], which this specification extends:
-        <pre class='idl'>
+        Extensions to the <a>Screen</a> interface
+      </h2>The <a data-cite="CSSOM-View">CSSOM View Module</a> specification
+      defines a <code>Screen</code> interface, which this specification

I think here we should to formally define and link to `Screen`. 

```suggestion
      defines the <code><dfn data-cite="CSSOM-View#screen">Screen</dfn></code> interface, which this specification
```

> @@ -151,29 +151,31 @@ <h2>
     </section>
     <section>
       <h2>
-        Interface definitions
-      </h2>
-      <section>
-        <h2>
-          Extensions to the <a>Screen</a> interface
-        </h2>The CSSOM View specification defines a <code>Screen</code>
-        interface [[!CSSOM-VIEW]], which this specification extends:
-        <pre class='idl'>
+        Extensions to the <a>Screen</a> interface
+      </h2>The <a data-cite="CSSOM-View">CSSOM View Module</a> specification

Note missing paragraph (will need a tidy after, and a closing `<p>`): 
```suggestion
      </h2><p>The <a data-cite="CSSOM-View">CSSOM View Module</a> specification
```

>            partial interface Screen {
             [SameObject] readonly attribute ScreenOrientation orientation;
           };
         </pre>
+      <section>
+        <h2>
+          <dfn data-dfn-for='Screen'>orientation</dfn> attribute

I'd suggest moving `data-dfn-for='Screen'` up to the `<section>` tag on line 152. That way, it's clear that the whole section is defining 'Screen''s things (even though there is only one attribute).  

>          <p>
-          The <dfn data-dfn-for='Screen'>orientation</dfn> object is an
-          instance of <a>ScreenOrientation</a>, which is described below.
+          The <a>orientation</a> attribute is an instance of
+          <a>ScreenOrientation</a>, which is described below.

Probably ok to drop the "which is described below", as it's hyperlinked. 

```suggestion
          <a>ScreenOrientation</a>.
```

-- 
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/screen-orientation/pull/130#pullrequestreview-190239771