Clarify example for omit graph flag

[Fak3]

The spec at https://github.com/w3c/json-ld-framing/blob/master/index.html#L639 says:

if the omit graph flag is true, the top-level @graph entry may be omitted.

But the output given in the example 4 (Framed library objects) and example 5 (Framed library objects with omitGraph set to false) are exactly the same, making it difficult to understand what the omit graph flag is for.

[gkellogg]

Yes, this needs to be updated. The omitGraph flag defaults to true in 1,1 mode, which is the default. Set it to false to get the @graph back, or use the 1.0 processor mode for the implied false value.

[Fak3]

Btw, I find the name of the flag a bit complicated to understand because of double-negation. I.e. in my mind "omit" means "don't include", and I always have to perform this mental exercise to parse 'don't include graph is False' into 'include graph'. Does anyone feels the same nuisance? Would it help to rename it to includeGraph?

[iherman]

This issue was discussed in a meeting.

• RESOLVED: Update examples 4 & 5 in Framing to be instructive as well as correct and close when updated
  View the transcript

  omit graph example
  Rob Sanderson: https://github.com/w3c/json-ld-framing/issues/88
  Gregg Kellogg: The issuer pointed out that we are using double negation, as omitGraph true is the default.
  … It made more sense in 1.0. But now the default value is reversed.
  … We could rename it in 1.1.
  Rob Sanderson: We probably don’t want to rename it to includeGraph?
  Proposed resolution: Update examples 4 & 5 in Framing to be instructive as well as correct (Rob Sanderson)
  Rob Sanderson: We should update the examples in framing to be more instructive.
  … This is just editorial.
  Proposed resolution: Update examples 4 & 5 in Framing to be instructive as well as correct and close when updated (Rob Sanderson)
  Ivan Herman: +1
  Rob Sanderson: +1
  Tim Cole: +1
  Ruben Taelman: +1
  Jeff Mixter: +1
  Adam Soroka: +1
  Pierre-Antoine Champin: +1
  Gregg Kellogg: +1
  Resolution #3: Update examples 4 & 5 in Framing to be instructive as well as correct and close when updated
  

[gkellogg]

@Fak3, please see updated text in PR #91. Please indicate if this satisfies your issue.

[Fak3]

Yes, this resolves the issue, thanks

[gkellogg]

Reopened for WG to dispose of.