Change notes referencing relevant tests to use the data-test ReSpec feature #62
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… feature. The test-manifest HTML generation can extract these from the spec, and update the HTML with back-references to the relevant part of the spec. For example, as is done for [YAML-LD tests](https://json-ld.github.io/yaml-ld/tests/manifest.html). Note References entry in most test cases that links back to the normative text. Although a fair amount of work, this can be done with other specs and tests, and becomes valuable for the Implementation Report. Ideally, each test would be referenced by one or more locations in the spec, and each normative statement would reference one or more tests.
gkellogg
added
the
spec:editorial
…erence and change data-tests entries to use .. relative pathing, where necessary.
gkellogg
added a commit
that referenced
this pull request
Jun 3, 2025
Co-authored-by: Ted Thibodeau Jr <[email protected]>
TallTed
reviewed
Jun 6, 2025
Co-authored-by: Ted Thibodeau Jr <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The test-manifest HTML generation can extract these from the spec, and generate the HTML with back-references to the relevant part of the spec.
For example, as is done for YAML-LD tests. Note References entry in most test cases that links back to the normative text.
Although a fair amount of work, this can be done with other specs and tests, and becomes valuable for the Implementation Report. Ideally, each test would be referenced by one or more locations in the spec, and each normative statement would reference one or more tests.
(See GitHack rendered version for test details).
Preview | Diff