<?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>29702</bug_id>
          
          <creation_ts>2016-06-21 15:59:35 +0000</creation_ts>
          <short_desc>[XP31] Production rules in the text not unambiguous as a result of missing annotations</short_desc>
          <delta_ts>2016-07-11 22:19:45 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>1</classification_id>
          <classification>Unclassified</classification>
          <product>XPath / XQuery / XSLT</product>
          <component>XPath 3.1</component>
          <version>Candidate Recommendation</version>
          <rep_platform>PC</rep_platform>
          <op_sys>Windows NT</op_sys>
          <bug_status>RESOLVED</bug_status>
          <resolution>FIXED</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard></status_whiteboard>
          <keywords></keywords>
          <priority>P2</priority>
          <bug_severity>editorial</bug_severity>
          <target_milestone>---</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Abel Braaksma">abel.braaksma</reporter>
          <assigned_to name="Michael Dyck">jmdyck</assigned_to>
          <cc>andrew_coleman</cc>
          
          <qa_contact name="Mailing list for public feedback on specs from XSL and XML Query WGs">public-qt-comments</qa_contact>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>126813</commentid>
    <comment_count>0</comment_count>
    <who name="Abel Braaksma">abel.braaksma</who>
    <bug_when>2016-06-21 15:59:35 +0000</bug_when>
    <thetext>As a result of [1], [2], [3] and [4] and the resolution in [5], caused by confusion about missing production annotations, the Joined WG asked me to write an editorial bug about improving the production rules that appear within the body of the specification.

The issue at hand: the production rules within the text do not maintain the annotations in A.1 EBNF, which confuses competent readers.

Proposal (my recollection of discussion in telcon #647)

1) Remove the following sentence from A.1

&quot;To increase readability, the EBNF in the main body of this document omits some of these notational features. This appendix is the normative version of the EBNF.&quot;

2) Update the stylesheets such that the annotations become part of the productions within the text, so that they are normatively equivalent.

3) Leave section A.1 as the Normative EBNF.


[1] https://lists.w3.org/Archives/Public/public-xsl-query/2016Jun/0047.html
[2] https://lists.w3.org/Archives/Public/public-xsl-query/2016Jun/0049.html
[3] https://lists.w3.org/Archives/Public/public-xsl-query/2016Jun/0053.html
[4] https://lists.w3.org/Archives/Public/public-xsl-query/2016Jun/0056.html
[5] https://lists.w3.org/Archives/Public/public-xsl-query/2016Jun/0057.html</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>126864</commentid>
    <comment_count>1</comment_count>
    <who name="Michael Dyck">jmdyck</who>
    <bug_when>2016-06-29 15:02:46 +0000</bug_when>
    <thetext>(In reply to Abel Braaksma from comment #0)
&gt; 
&gt; 2) Update the stylesheets such that the annotations become part of the
&gt; productions within the text, so that they are normatively equivalent.

Done. This should be visible in the XPath/XQuery 3.1 specs the next time they&apos;re built+committed.

It will also affect two other 3.1-series documents if they&apos;re ever built again:
 -- Full Text 3.1 (in the production for Pragma)
 -- Update 3.1    (in the productions for FunctionDecl and FunctionCall)</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>126865</commentid>
    <comment_count>2</comment_count>
    <who name="Michael Dyck">jmdyck</who>
    <bug_when>2016-06-29 15:06:36 +0000</bug_when>
    <thetext>(In reply to Abel Braaksma from comment #0)
&gt; 
&gt; 1) Remove the following sentence from A.1
&gt; 
&gt; &quot;To increase readability, the EBNF in the main body of this document omits
&gt; some of these notational features. This appendix is the normative version of
&gt; the EBNF.&quot;
&gt; 
&gt; 3) Leave section A.1 as the Normative EBNF.

But if A,1 is the normative EBNF, shouldn&apos;t we still say that it is?</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>126867</commentid>
    <comment_count>3</comment_count>
    <who name="Abel Braaksma">abel.braaksma</who>
    <bug_when>2016-06-30 07:35:07 +0000</bug_when>
    <thetext>(In reply to Michael Dyck from comment #2)
&gt; &gt; 
&gt; &gt; 3) Leave section A.1 as the Normative EBNF.
&gt; 
&gt; But if A,1 is the normative EBNF, shouldn&apos;t we still say that it is?
Yes, I thought that was the idea. With &quot;leave&quot;, I meant &quot;leave it in as&quot;, i.e., keep the status quo that A.1 is Normative.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>126870</commentid>
    <comment_count>4</comment_count>
    <who name="Michael Dyck">jmdyck</who>
    <bug_when>2016-06-30 18:44:56 +0000</bug_when>
    <thetext>(In reply to Abel Braaksma from comment #3)
&gt; (In reply to Michael Dyck from comment #2)
&gt; &gt; &gt; 
&gt; &gt; &gt; 3) Leave section A.1 as the Normative EBNF.
&gt; &gt; 
&gt; &gt; But if A,1 is the normative EBNF, shouldn&apos;t we still say that it is?
&gt; Yes, I thought that was the idea.

But point #1 says to remove the sentence that asserts that the appendix is the normative version of the EBNF.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>126876</commentid>
    <comment_count>5</comment_count>
    <who name="Abel Braaksma">abel.braaksma</who>
    <bug_when>2016-07-01 05:32:49 +0000</bug_when>
    <thetext>(In reply to Michael Dyck from comment #4)
&gt; But point #1 says to remove the sentence that asserts that the appendix is
&gt; the normative version of the EBNF.
It says: remove that sentence. And #3 says to leave the section in, as a whole. Since we only specify explicitly when it is non-normative (like with A.4), I don&apos;t think we need to overstate it when it is normative. If the productions in both text and this section are now equal, they can both be normative. Stating it is normative suggests that the in-line productions may be different.

I think it is better to leave it out, but I can live with it either way.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>126881</commentid>
    <comment_count>6</comment_count>
    <who name="Michael Dyck">jmdyck</who>
    <bug_when>2016-07-01 13:55:46 +0000</bug_when>
    <thetext>(In reply to Abel Braaksma from comment #5)
&gt;
&gt; If the productions in both text and this section are now equal,
&gt; they can both be normative. Stating it is normative suggests
&gt; that the in-line productions may be different.

That&apos;s fine with me. But it&apos;s not the impression I get from point #3.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>126933</commentid>
    <comment_count>7</comment_count>
    <who name="Andrew Coleman">andrew_coleman</who>
    <bug_when>2016-07-08 13:04:01 +0000</bug_when>
    <thetext>At the meeting on 2016-07-05, the WG agreed to resolve this with the following action:

Action 649-03: mdyck to resolve Bug 29702 at his discretion.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>126949</commentid>
    <comment_count>8</comment_count>
    <who name="Michael Dyck">jmdyck</who>
    <bug_when>2016-07-11 22:19:45 +0000</bug_when>
    <thetext>To finish resolving this bug, I carried out the change proposed in point #1, and ignored point #3.</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>