-
Notifications
You must be signed in to change notification settings - Fork 35
improve 'term definition' definition #638
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
base: main
Are you sure you want to change the base?
Conversation
I'm not entirely satisfied with the addition in common/terms.html, as it seems too detailed for the terminology section. But... ...as pointed out in the comment of #630, the API spec references to this definition in multiple places, and many of those links are actually for instances of the internal representation, *not* for instances of the strings or maps that represent term definition in JSON. So the alternative would be to introduce a new name for those "internal term definition" and patch all the algorithms... which seems laborious and error-prone. @gkellogg I don't remember what's the process for synchronizing the files in common with other specs.
Just needs to be copied. The GH Action checks out common and compares the results. |
Co-authored-by: Ted Thibodeau Jr <[email protected]>
This one probably also needs to be formatted as a candidate amendment... |
I didn't follow the pattern 'change_N' for the id, because this change will also be present in json-ld-syntax (in comment/terms), and so will probably require a candidate addition in that spec too (with a different index). Hence the more robust id used here.
<ins cite="#change_api_638"><br/> | ||
For <a data-cite="JSON-LD11-API#context-processing-algorithms">context processing</a>, <a>term definition</a> values are converted internally to a dedicated data structure that is easier to process.</ins> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The problem with this is that that will show up in syntax and framing, as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, that's why I named it change_api_638
insteal of change_8
. That way, we can add a change marker in the other specs without an ID clash.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll need issues for those other specs to have their own version of this update.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I created w3c/json-ld-syntax#461 to track this in Syntax, so I think we can probably merge this now.
Co-authored-by: Ted Thibodeau Jr <[email protected]>
This was discussed during the #json-ld meeting on 04 June 2025. View the transcriptw3c/json-ld-api#638<gb> Pull Request 638 address #630 (by pchampin) [needs discussion] [class-2] pchampin: This is about inverse context creation. bigbluehat: thoughts? especially on the size of the change? bigbluehat: Looks like some validation errors. gkellogg: I think it's good to go bigbluehat: do we need to synchronize those changes across the specs? gkellogg: the json-ld-commons repository is where the term changes would happen pchampin: yep |
@gkellogg I actually don't see any markup issue there; the only reported issue is the inconsistency of the common files between the different repos, which is to be expected. |
Great. The thing to do is to update json-ld-common with the change to the common files. After that is merged, this should build cleanly. We'll need to do similar updates to common files in other repos, and possibly rebase some open PRs. |
I'm not entirely satisfied with the addition in common/terms.html, as it seems too detailed for the terminology section. But...
...as pointed out in the comment of #630,
the API spec references to this definition in multiple places, and many of those links are actually for instances of the internal representation, not for instances of the strings or maps that represent term definition in JSON.
So the alternative would be to introduce a new name for those "internal term definition" and patch all the algorithms... which seems laborious and error-prone.
@gkellogg I don't remember what's the process for synchronizing the files in common with other specs.
Preview | Diff