Uploaded image for project: 'OASIS Open Data Protocol (OData) TC'
  1. OASIS Open Data Protocol (OData) TC
  2. ODATA-381

Hanging paragraphs - all current csprd01 documents

    XMLWordPrintable

    Details

      Description

      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.

        Attachments

          Activity

            People

            • Assignee:
              mikep Michael Pizzo
              Reporter:
              patrick Patrick Durusau
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: