w3c / did-core

W3C Decentralized Identifier Specification v1.0
https://www.w3.org/TR/did-core/
Other
404 stars 94 forks source link

Change note on order to advisement #665

Closed OR13 closed 3 years ago

OR13 commented 3 years ago

Preview | Diff

msporny commented 3 years ago

@TallTed, now's your chance to try a few things out with this advisement.

TallTed commented 3 years ago

Repeating my comment from over there, over here --

I want to make a small change to the text within that box ... but it's further away from the single-word change you made than github will allow me to make a suggestion on.

I'd change --

    <p class="note" title="Ordering of values">
As a result of the <a href="#data-model">data model</a> being defined using
terminology from [[INFRA]], property values which can contain more than one
item, such as <a data-cite="INFRA#ordered-map">maps</a> and
<a data-cite="INFRA#ordered-set">sets</a>, are explicitly ordered. For the
purposes of this specification, unless otherwise stated, ordering is not
important and implementations are not expected to produce or consume
deterministically ordered values.
    </p>

-- to --

    <p class="advisement" title="Ordering of values">
As a result of the <a href="#data-model">data model</a> being defined using
terminology from [[INFRA]], property values which can contain more than one
item, such as <a data-cite="INFRA#ordered-map">maps</a> and
<a data-cite="INFRA#ordered-set">sets</a>, are explicitly ordered. (All
list-like value structures in [[INFRA]] are ordered, whether or not that 
order is significant.) For the
purposes of this specification, unless otherwise stated, ordering is not
important and implementations are not expected to produce or consume
deterministically ordered values.
    </p>

To be clear, I've added (All list-like value structures in [[INFRA]] are ordered, whether or not that order is significant.)

And I still think that all the links to "INFRA#ordered-set" within the document should be changed to an internal description that includes something like "The order of values in this list-like structure isn't significant, even though INFRA says it is" before the reader gets to the INFRA site.

msporny commented 3 years ago

Applied @TallTed's changes in 27b5fe4d235ff5af89e606bb809c1a148bbe3266.

And I still think that all the links to "INFRA#ordered-set" within the document should be changed to an internal description that includes something like "The order of values in this list-like structure isn't significant, even though INFRA says it is" before the reader gets to the INFRA site.

Will contemplate how to do this cleanly... you may want to raise an issue for it so we don't forget, @TallTed.

msporny commented 3 years ago

Editorial, multiple reviews, changes requested and made, no objections, merging.