search

json-ld / yaml-ld

CG specification for YAML-LD and UCR
https://json-ld.github.io/yaml-ld/spec
Other
22 stars 8 forks source link

Fix: #38. Stubs Conformance. #39

Closed ioggstream closed 2 years ago

ioggstream commented 2 years ago

This PR

Preview | Diff

ioggstream commented 2 years ago

I suggest to do this referencing job in a subsequent editorial PR once the referenced terms are consolidated filing another issue like #40

JSON-LD ... defined the imported terms locally

IIUC, in json-ld there are copy-pasted definitions from other documents. Is that correct? I think we should just use references, so that people is encouraged to read the original documents: an implementer is expected to read the JSON, JSON-LD and YAML spec. The fact that they won't do it should be addressed e.g. in the Appendix.

In my recent ramblings on other specs I spent a good amount of time replacing copied definitions with hrefs to make them coherent with the latest HTTP spec (RFC9110): this work would have been easier if they just used hrefs :)

WDYT?

gkellogg commented 2 years ago

IIUC, in json-ld there are copy-pasted definitions from other documents. Is that correct? I think we should just use references, so that people is encouraged to read the original documents: an implementer is expected to read the JSON, JSON-LD and YAML spec. The fact that they won't do it should be addressed e.g. in the Appendix.

Not exactly, consider the term "JSON object". It has an entry in the dl for Terms imported from Other Specifications, but the key is a reference to RFC8259. But, by defining a dfn for this, we can simply use <a>JSON Object</a> rather than the more lengthly <a data-cite="RFC8259#section-4">JSON Object</a> within the body of the document for every occurrence; it will use the reference directly into RFC8259, rather than that in the dl. It simplifies later usage, and provides a single place for us to describe the terms we are importing, vs defining. Yes, there is a brief description, but that is mostly to describe the context for usage within JSON-LD, not to repeat the definition from the referenced spec.

ioggstream commented 2 years ago

brief description ...

@gkellogg ah, ok. I'll file it in a separate, editorial, issue. Since I'm working on 4 other I-Ds, it would be great if during today's call we could find someone volounteering on those editorial stuff.

See #47

ioggstream commented 2 years ago

Moved the other issue to #47. @gkellogg feel free to merge

gkellogg commented 2 years ago

This PR was discussed in the 2022-07-06 meeting, and it was agreed to merge.