Skip to content

Commit fc56eb4

Browse files
committed
Add a description of rule identifiers
1 parent 0668397 commit fc56eb4

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/introduction.md

+9
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,15 @@ These conventions are documented here.
120120
121121
See [Notation] for more detail.
122122

123+
* 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).
124+
125+
The rule name can be clicked to link to that rule.
126+
127+
r[example.rule.label]
128+
129+
> [!WARNING]
130+
> 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.
131+
123132
## Contributing
124133

125134
We welcome contributions of all kinds.

0 commit comments

Comments
 (0)