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

Gen-ART editorial comment #57

Closed
mnot opened this issue Oct 30, 2022 · 2 comments
Closed

Gen-ART editorial comment #57

mnot opened this issue Oct 30, 2022 · 2 comments

Comments

@mnot
Copy link
Member

mnot commented Oct 30, 2022

This paragraph in section 4 struck me oddly:

An extension member (see Section 3.2) MAY occur in the Problem field
if its name is compatible with the syntax of Dictionary keys (see
Section 3.2 of [STRUCTURED-FIELDS]) and if the defining problem type
specifies a Structured Type to serialize the value into.

That almost sounds like what you want to say is:

If an extension member (see Section 3.2) occurs in the Problem field,
its name MUST be compatible with the syntax of Dictionary keys (see
Section 3.2 of [STRUCTURED-FIELDS]) and the defining problem type
MUST specify a Structured Type to serialize the value into.

I'm curious if you are making a normative statement that would get lost in the
current form. But I'm not sure what the high-order bit here is, so I leave it
to you.

@mnot mnot added the editorial label Oct 30, 2022
@dret
Copy link
Collaborator

dret commented Oct 30, 2022

it seems to me that the updated version captures the goal better than the original. after all, we want to disallow fields that aren't well-defined or serializable.
a general problem with this snippet (independent of the rewording) is that "type" is optional, so technically there isn't always a "defining problem type". do we want to address this case explicitly (either in the old or in the new wording)?

@mnot
Copy link
Member Author

mnot commented Nov 29, 2022

Type is optional, but it defaults to something well-defined, so I don't think that's an issue.

@mnot mnot closed this as completed in 03b44da Nov 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

2 participants