[OASIS Issue Tracker] Updated: (ODATA-381) Hanging paragraphs - all current csprd01 documents

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

     [ http://tools.oasis-open.org/issues/browse/ODATA-381?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael Pizzo updated ODATA-381:
--------------------------------

       Proposal: Be clear, in conformance section, when we are referring just to section or include subsections  (was: Remove all hanging paragraphs.)
    Environment: [Proposed]

As discussed in June 29 TC call, the issue is whether or not references to hanging paragraphs mean just the content of that section or includes subsections. In [Protocol] most references are to sections with no subsections. In a few cases the conformance is described in the section without including subsections, and there are only 3 references to sections that include subsections.

The easiest way to address this appears to be to clarify, in the conformance statements of each document, those three statements that explicitly include subsections.  For example:

11.MUST support the  $batch system query option (section 11.611.7 and all subsections)

> Hanging paragraphs - all current csprd01 documents
> --------------------------------------------------
>
>                 Key: ODATA-381
>                 URL: http://tools.oasis-open.org/issues/browse/ODATA-381
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Bug
>          Components: OData ATOM Format , OData CSDL, OData JSON Format, OData Protocol , OData URL Conventions 
>    Affects Versions: V4.0_CSD01
>         Environment: [Proposed]
>            Reporter: Patrick Durusau
>            Priority: Minor
>             Fix For: V4.0_CSD02
>
>
> The current drafts have what are known as "hanging paragraphs." 
> As an example, from odata-v4.0-csprd01-part1-protocol:
> ****
> 8 Header Fields
> OData defines semantics around the following request and response headers. Additional headers MAY be specified, but have no unique semantics defined in OData.
> 8.1 Common Headers
> The OData-Version and Content-Type headers are common between OData requests and responses.
> ****
> If I say, conform to Section 8, do I mean:
> All of section 8 or do I mean only the paragraph following section 8, but not any of the following subsections?
> This happens with sub-sections as well, see odata-v4.0-csprd01-part2-url-conventions:
> ****
> 5.1.1.5 Lambda Operators
> OData defines two operators that evaluate a Boolean expression on a collection. Both must be prepended with a navigation path that identifies a collection. 
> 5.1.1.5.1 any 
> The any operator applies a Boolean expression to each member of a collection and evaluates to true if and only if the expression is true for any member of the collection. As a special case the Boolean expression may be empty, in which case the any operator evaluates to true if the collection is not empty.  
> ****
> If I say conform to 5.1.1.5 Lambda Operators, as in "prepend[ing]" a navigation path that identifies a collection, do I also mean conform to all the subparagraphs that follow? Or do I mean just that part? 
> Formally it is an ambiguous reference to have content following a section division that has sub-divisions. It isn't possible to resolve from the text along, say for a conformance clause, the meaning of the reference. Meaning different readers will assign different meanings to the reference. 

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://tools.oasis-open.org/issues/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira