Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"A non-exhaustive list of valid values defined by this specification are" is weird language #138

Closed
jogu opened this issue Dec 8, 2023 · 4 comments · Fixed by #238
Closed

Comments

@jogu
Copy link
Contributor

jogu commented Dec 8, 2023

The current draft contains phrases about "non-exhaustive list of valid values defined by this specification" in a few places:

non-exhaustive list of valid values defined by this specification are string, number, and image media types such as image/jpeg as defined in IANA media type registry for images

(e.g. https://openid.github.io/OpenID4VCI/openid-4-verifiable-credential-issuance-wg-draft.html#appendix-E.2.2 )

To express the specifics about the claim, the most deeply nested value MAY be an object that includes a following non-exhaustive list of parameters defined by this specification:

(e.g. https://openid.github.io/OpenID4VCI/openid-4-verifiable-credential-issuance-wg-draft.html#appendix-E.1.1.2 )

In both cases I've not been able to find an exhaustive list of the values that the specification does actually define. I'm not sure exactly what is meant, in other parts of the specification language like "Below is a non-exhaustive list of valid parameters that MAY be included" is used which may be the intention, or perhaps it is more like "This specification defines the following parameters, other parameters may be used and implementations MUST ignore unrecognised parameters"?

@Sakurann
Copy link
Collaborator

in the first example, string, number, and image media types such as image/jpeg as defined in IANA media type registry is the non-exhaustive list.

in the second case, parameters that follow (mandatory, value_type, display) is the non-exhaustive list.

@jogu
Copy link
Contributor Author

jogu commented Dec 23, 2023

in the first example, string, number, and image media types such as image/jpeg as defined in IANA media type registry is the non-exhaustive list.

Isn't that "an exhaustive list of the values defined by this specification"? Or are there more values defined elsewhere in VCI?

i.e. I read "A non-exhaustive list of valid values defined by this specification are" as "this is some of the values defined by this specification, there are also other values defined in other sections of this specification".

So if we look at:

A non-exhaustive list of valid values defined by this specification are string, number, and image media types such as image/jpeg as defined in IANA media type registry for images"

I guess the intention is something like:

Valid values are string, number, and image media types (for example, image/jpeg) as defined in IANA media type registry for images. Other values may also be used.

?

@selfissued
Copy link
Member

I would drop the word "valid" from the phrases "valid values" and "valid parameters" since it doesn't add anything to the meaning.

I can add this change to PR #191 if people agree.

@Sakurann
Copy link
Collaborator

Sakurann commented Jan 18, 2024

I guess the intention is something like:

Valid values are string, number, and image media types (for example, image/jpeg) as defined in IANA media type registry for images. Other values may also be used.

I think so. I think non-exhaustive was meant to express "Other values may also be used" and not "there are also other values defined in other sections of this specification".

I also do think valid is an important adjective here..

@jogu jogu self-assigned this Jan 29, 2024
Sakurann added a commit that referenced this issue Feb 1, 2024
…ion' (#238)

editorial. 2 approvals.

* Clarify 'non-exhaustive list of the values defined by this specification'

closes #138

* Apply suggestions from code review

Co-authored-by: Kristina <52878547+Sakurann@users.noreply.github.com>

* Fix other places I'd removed 'defined by this specification'

---------

Co-authored-by: Kristina <52878547+Sakurann@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants