Add note to allow synchronous APIs
authorMarkus Lanthaler <mark_lanthaler@gmx.net>
Thu, 09 Aug 2012 17:07:42 +0200
changeset 795 e5d38151dac4
parent 794 de6219d3233e
child 799 7b0928c9cbcf
Add note to allow synchronous APIs

@niklasl, @msporny, @gkellogg could you please check if this is sufficient.

This closes #147.
spec/latest/json-ld-api/index.html
spec/latest/json-ld-framing/index.html
--- a/spec/latest/json-ld-api/index.html	Wed Aug 01 18:21:29 2012 +0200
+++ b/spec/latest/json-ld-api/index.html	Thu Aug 09 17:07:42 2012 +0200
@@ -734,10 +734,13 @@
   <section>
     <h3>JsonLdProcessor</h3>
 
-    <p>
-The JSON-LD Processor interface is the high-level programming structure that
-developers use to access the JSON-LD transformation methods.
-    </p>
+    <p>The JSON-LD processor interface is the high-level programming structure that developers
+      use to access the JSON-LD transformation methods.</p>
+
+    <p class="note">The JSON-LD API signatures are the same across all programming languages. Due
+      to the fact that asynchronous programming is uncommon in certain languages, developers MAY
+      implement processor with a synchronous interface instead. In that case the <code>callback</code>
+      parameter MUST NOT be included.</p>
 
     <dl title="[NoInterfaceObject] interface JsonLdProcessor" class="idl">
 
--- a/spec/latest/json-ld-framing/index.html	Wed Aug 01 18:21:29 2012 +0200
+++ b/spec/latest/json-ld-framing/index.html	Thu Aug 09 17:07:42 2012 +0200
@@ -439,6 +439,16 @@
 
   <section>
     <h3>JsonLdProcessor</h3>
+
+    <p>The JSON-LD processor interface is the high-level programming structure that developers
+      use to access the JSON-LD transformation methods. The definition below is an experimental
+      extension of the interface defined in the [[JSON-LD-API]].</p>
+
+    <p class="note">The JSON-LD API signatures are the same across all programming languages. Due
+      to the fact that asynchronous programming is uncommon in certain languages, developers MAY
+      implement processor with a synchronous interface instead. In that case the <code>callback</code>
+      parameter MUST NOT be included.</p>
+
     <dl title="[NoInterfaceObject] interface JsonLdProcessor" class="idl">
 
       <dt>void frame()</dt>