w3c / json-ld-syntax

JSON-LD 1.1 Specification
https://w3c.github.io/json-ld-syntax/
Other
112 stars 22 forks source link

Syntax examples missing the result of compaction #179

Closed kasei closed 5 years ago

kasei commented 5 years ago

The paragraph just above example 77 talks about what happens during compaction (in this case, nesting), but the example does not show results of that compaction process. (This happens repeatedly, including examples 86, 89, and 92.)

Similarly, term definitions may contain a @nest property referencing a term aliased to @nest which will cause such properties to be nested under that aliased term when compacting. In the example below, both main_label and other_label are defined with "@nest": "labels", which will cause them to be serialized under labels when compacting.

(emphasis added)

azaroth42 commented 5 years ago

Or indeed that the results are in the "original" tab, which gives the impression that it is the input to the compaction process, rather than the output.

Suggest renaming "Original" to "Compacted" throughout. And in the text, say which tab is the input data and which is the result of the algorithm being applied. This is likely always Statements -> Compacted, but there might be some where the example is for Expansion.