w3c / w3c/json-ld-api

missing instructions in Node Map generation

Open
#549 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ErratumRaised spec:bug substantive:class 3
Dominant language
HTML
Stars
106
Forks
40
PR merge metrics
No merged PRs in 30d

Description

I believe that an instruction is missing from step 6.10 of Node Map Generation, namely:

  • if node map does not contain an id entry, create one and initialize its value to an empty map

before recursively invoking the algorithm.
Indeed, in step 2 of the invoked algorithm, that entry is assumed to already exist:

Reference the map which is the value of the active graph entry of node map")

(edited wrong markup, which made the suggested sentence potentially harder to understand)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with step 6.10 of the Node Map Generation section in the linked JSON-LD 1.1 API specification, then compare it with step 2 of the recursively invoked algorithm. Confirm whether the node map's id entry must be initialized before recursion, update the specification wording accordingly, and verify that the surrounding algorithm steps remain consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.