Skip to content

Commit 6e23c07

Browse files
authored
Merge pull request #1753 from ehuss/intro-rule-info
Add more information on rules and tests
2 parents 6288200 + 3af2bd4 commit 6e23c07

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/introduction.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -113,15 +113,18 @@ These conventions are documented here.
113113
114114
See [Notation] for more detail.
115115

116-
* Rule identifiers appear before each language rule enclosed in square brackets. These identifiers provide a way to refer to a specific rule in the language. The rule identifier uses periods to separate sections from most general to most specific ([destructors.scope.nesting.function-body] for example).
116+
r[example.rule.label]
117+
* Rule identifiers appear before each language rule enclosed in square brackets. These identifiers provide a way to refer to a specific rule in the language. The rule identifier uses periods to separate sections from most general to most specific ([destructors.scope.nesting.function-body] for example). On narrow screens, the rule name will collapse to display `[*]`.
117118

118119
The rule name can be clicked to link to that rule.
119120

120-
r[example.rule.label]
121-
122121
> [!WARNING]
123122
> The organization of the rules is currently in flux. For the time being, these identifier names are not stable between releases, and links to these rules may fail if they are changed. We intend to stabilize these once the organization has settled so that links to the rule names will not break between releases.
124123
124+
* Rules that have associated tests will include a `Tests` link below them (no narrow screens, the link is `[T]`). Clicking the link will pop up a list of tests, which can be clicked to view the test. For example, see [input.encoding.utf8].
125+
126+
Linking rules to tests is an ongoing effort. See the [Test summary](test-summary.md) chapter for an overview.
127+
125128
## Contributing
126129

127130
We welcome contributions of all kinds.

0 commit comments

Comments
 (0)