You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/conventions.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Like all technical books, this book has certain conventions in how it displays i
7
7
## Rules
8
8
9
9
r[example.rule.label]
10
-
Rule identifiers appear before each language rule enclosed in square brackets. These identifiers provide a way to refer to and link to a specific rule in the language ([e.g.][example rule]). 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 `[*]`.
10
+
Rule identifiers appear before each language rule, enclosed in square brackets. These identifiers provide a way to refer to and link to a specific rule in the language ([e.g.][example rule]). 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 `[*]`.
11
11
12
12
The rule name can be clicked to link to that rule.
13
13
@@ -16,16 +16,18 @@ The rule name can be clicked to link to that rule.
16
16
17
17
### Rule tests
18
18
19
-
Rules that have associated tests will include a `Tests` link below them (on 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].
19
+
Rules that have associated tests will include a `Tests` link below them (on narrow screens, the link is `[T]`). Clicking the link will display a list of tests, which can be clicked to view each test. For example, see [input.encoding.utf8].
20
20
21
-
Linking rules to tests is an ongoing effort. See the [Test summary](test-summary.md) chapter for an overview.
21
+
Linking rules to tests is an ongoing effort. See the [test summary] chapter for an overview.
22
22
23
23
## Definitions
24
24
25
25
Statements that define a term contain that term in *italics*. Whenever that term is used outside of that chapter, it is usually a link to the section that has this definition.
26
26
27
27
An *example term* is an example of a term being defined.
28
28
29
+
The [glossary] contains a list of definitions.
30
+
29
31
## Examples
30
32
31
33
Example blocks show an example that demonstrates some rule or points out some interesting aspect. Some examples may have hidden lines which can be viewed by clicking the eye icon that appears when hovering or tapping the example.
@@ -38,22 +40,20 @@ Example blocks show an example that demonstrates some rule or points out some in
0 commit comments