Skip to content

Commit 54ccc85

Browse files
committed
Apply some light edits to the conventions chapter
1 parent c7eb5ad commit 54ccc85

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

src/conventions.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Like all technical books, this book has certain conventions in how it displays i
77
## Rules
88

99
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 `[*]`.
1111

1212
The rule name can be clicked to link to that rule.
1313

@@ -16,16 +16,18 @@ The rule name can be clicked to link to that rule.
1616
1717
### Rule tests
1818

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].
2020

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.
2222

2323
## Definitions
2424

2525
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.
2626

2727
An *example term* is an example of a term being defined.
2828

29+
The [glossary] contains a list of definitions.
30+
2931
## Examples
3032

3133
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
3840
3941
## Code blocks
4042
41-
Code snippets inline in the text are inside `<code>` tags.
42-
43-
Longer code examples are in a syntax highlighted box that has controls for copying, executing, and showing hidden lines in the top right corner.
43+
Code examples have controls for copying, executing, and showing hidden lines in the top right corner.
4444
4545
```rust
4646
# // This is a hidden line.
4747
fn main() {
48-
println!("This is a code example");
48+
println!("This is a code example");
4949
}
5050
```
5151
5252
All examples are written for the latest edition unless otherwise stated.
5353

5454
## Grammar
5555

56-
The grammar and lexical productions are described in the [Notation] chapter.
56+
The grammar and lexical productions are described in the [grammar notation chapter][notation].
5757

5858
## Notes
5959

@@ -77,3 +77,5 @@ The main text describes the latest stable edition. Differences to previous editi
7777
> Before the 2018 edition, the behavior was this. As of the 2018 edition, the behavior is that.
7878
7979
[example rule]: example.rule.label
80+
[Glossary]: glossary.md
81+
[test summary]: test-summary.md

0 commit comments

Comments
 (0)