Skip to content

Commit

Permalink
Clarify name of "observability" property (w3c#101)
Browse files Browse the repository at this point in the history
In w3c/network-error-logging#77 there was some confusion about what
"observable from JavaScript" means.  The intended meaning is very
specific: the report will not be handed off to any registered
`ReportingObserver`s.  Another reading that is you can perform whatever
complicated analysis you want, and somehow detect that a report was
created.  This patch renames the term to something that hopefully can
only be read in the more specific way.
  • Loading branch information
dcreager authored Jul 9, 2018
1 parent b3af33a commit f6e72c5
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions index.src.html
Original file line number Diff line number Diff line change
Expand Up @@ -314,10 +314,10 @@ <h3 id="concept-report-type">Report Type</h3>
that is contained in the [=report/body=] of a <a>report</a>.

When a <a>report type</a> is defined (in this spec or others), it can be
specified to be <dfn>observable from JavaScript</dfn>, meaning
specified to be <dfn>visible to <code>ReportingObserver</code>s</dfn>, meaning
that <a>reports</a> of that type can be observed by a <a>reporting
observer</a>. By default, <a>report types</a> are not <a>observable from
JavaScript</a>.
observer</a>. By default, <a>report types</a> are not <a>visible to
<code>ReportingObserver</code>s</a>.

Note: See [[#deprecation-report]] as an example <a>report type</a> definition.

Expand Down Expand Up @@ -1084,8 +1084,8 @@ <h3 id="add-report" algorithm>
algorithm adds |report| to |observer|'s <a>report list</a>, so long as
|report|'s <a>type</a> is observable by |observer|.

1. If |report|'s [=report/type=] is not <a>observable from JavaScript</a>,
return.
1. If |report|'s [=report/type=] is not <a>visible to
<code>ReportingObserver</code>s</a>, return.

2. If |observer|'s <a>options</a> has a non-empty
{{ReportingObserverOptions/types}} member which does not contain |report|'s
Expand Down Expand Up @@ -1135,7 +1135,8 @@ <h3 id="deprecation-report">Deprecation</h3>

<a>Deprecation reports</a> have the <a>report type</a> "deprecation".

<a>Deprecation reports</a> are <a>observable from JavaScript</a>.
<a>Deprecation reports</a> are <a>visible to
<code>ReportingObserver</code>s</a>.

<pre class="idl">
interface DeprecationReportBody : ReportBody {
Expand Down Expand Up @@ -1190,7 +1191,8 @@ <h3 id="intervention-report">Intervention</h3>

<a>Intervention reports</a> have the <a>report type</a> "intervention".

<a>Intervention reports</a> are <a>observable from JavaScript</a>.
<a>Intervention reports</a> are <a>visible to
<code>ReportingObserver</code>s</a>.

<pre class="idl">
interface InterventionReportBody : ReportBody {
Expand Down

0 comments on commit f6e72c5

Please sign in to comment.