Add basic support for tagging text in the spec #1769
+25
−1
Conversation
This file contains 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
This adds two things: 1. Custom CSS to add a subtle dotted underline on hover to any element with an ID starting with `qx_` (an arbitrary prefix unlikely to be used by chance). 2. An example tag `qx_x0_is_zero`, tagging the text that specifies that x0 is hardwired to 0. This just adds a single tag as an exmaple, but the intention is that such tags would be added throughout the spec, allowing coverage, test plans, tests, documentation, etc. to all link to specific parts of the spec. The text of these tags can also be extracted via Asciidoc's docbook output format, enabling more use cases such as monitoring for spec changes.
|
It looks like this (when hovered):
|
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.
This adds two things:
qx_(an arbitrary prefix unlikely to be used by chance).qx_x0_is_zero, tagging the text that specifies that x0 is hardwired to 0.This just adds a single tag as an exmaple, but the intention is that such tags would be added throughout the spec, allowing coverage, test plans, tests, documentation, etc. to all link to specific parts of the spec.
The text of these tags can also be extracted via Asciidoc's docbook output format, enabling more use cases such as monitoring for spec changes.
See #1397