Uploaded image for project: 'Technical Advisory Board'
  1. Technical Advisory Board
  2. TAB-1361

"for example," examples or notes? 14 cases

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: New
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: Authentication Step-Up Protocol and Metadata Version 1.0
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • Environment:

      Style

    • Proposal:
      Hide

      Consider labeled notes for the "for example" sentences (14).

      Show
      Consider labeled notes for the "for example" sentences (14).

      Description

      Reading the "for example" sentences in:

      2 Landscape and Context - 2

      3 Conceptual Models - 1

      4 Architecture & Design Considerations - 7

      5 Implementation Considerations - 4

      I was struck by their seeming to be more in the quality of notes than examples.

      Take the one in 3.3.2:

      *****
      The authorization server, guided by policies set by the owner of the protected resource, elevates trust by testing whether the requesting party meets the policies. As part of this process, it can demand, for example, that the requesting party (or the client on their behalf) provide claims, such as identity information or even promises to adhere to constraints set by the resource owner, such as an embargo on information release until a certain date.
      *****

      The "for example" sentence seems to me to be more of a note that says the same thing as the first normative sentence but itself is just extra information for the reader to make sure they understand the normative requirement.

      Thus:

      The authorization server, guided by policies set by the owner of the protected resource, elevates trust by testing whether the requesting party meets the policies.

      Note: As part of this process, an authentication server can demand, that the requesting party (or the client on their behalf) provide claims, such as identity information or even promises to adhere to constraints set by the resource owner, such as an embargo on information release until a certain date.

            • so that it is clear the normative statement is that the server tests all policies and not just dates, the note illustrates that point with an example.

      Yes?

      A fairly minor point but thought it would help distinguish the normative text from where you mean to simply illustrate its use.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              patrick Patrick Durusau
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: