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
The intent here is to tie together the different conventions used in the
book (with the grammar), and to provide a more focused place to house
this content. I've also noticed this is a more common approach to
including this kind of content.
Like all technical books, this book has certain conventions in how it displays information. These conventions are documented here.
6
+
7
+
* 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.
8
+
9
+
An *example term* is an example of a term being defined.
10
+
11
+
* The main text describes the latest stable edition. Differences to previous editions are separated in edition blocks:
12
+
13
+
> [!EDITION-2018]
14
+
> Before the 2018 edition, the behavior was this. As of the 2018 edition, the behavior is that.
15
+
16
+
* Notes that contain useful information about the state of the book or point out useful, but mostly out of scope, information are in note blocks.
17
+
18
+
> [!NOTE]
19
+
> This is an example note.
20
+
21
+
* 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.
All examples are written for the latest edition unless otherwise stated.
46
+
47
+
* The grammar and lexical productions are described in the [Notation] chapter.
48
+
49
+
r[example.rule.label]
50
+
* 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 `[*]`.
51
+
52
+
The rule name can be clicked to link to that rule.
53
+
54
+
> [!WARNING]
55
+
> 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.
56
+
57
+
* 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].
58
+
59
+
Linking rules to tests is an ongoing effort. See the [Test summary](test-summary.md) chapter for an overview.
Copy file name to clipboardExpand all lines: src/introduction.md
-59Lines changed: 0 additions & 59 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,64 +45,6 @@ That said, there is no wrong way to read this book. Read it however you feel hel
45
45
> [!NOTE]
46
46
> For known bugs and omissions in this book, see our [GitHub issues]. If you see a case where the compiler behavior and the text here do not agree, file an issue so we can think about which is correct.
47
47
48
-
### Conventions
49
-
50
-
Like all technical books, this book has certain conventions in how it displays information. These conventions are documented here.
51
-
52
-
* 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.
53
-
54
-
An *example term* is an example of a term being defined.
55
-
56
-
* The main text describes the latest stable edition. Differences to previous editions are separated in edition blocks:
57
-
58
-
> [!EDITION-2018]
59
-
> Before the 2018 edition, the behavior was this. As of the 2018 edition, the behavior is that.
60
-
61
-
* Notes that contain useful information about the state of the book or point out useful, but mostly out of scope, information are in note blocks.
62
-
63
-
> [!NOTE]
64
-
> This is an example note.
65
-
66
-
* 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.
All examples are written for the latest edition unless otherwise stated.
91
-
92
-
* The grammar and lexical productions are described in the [Notation] chapter.
93
-
94
-
r[example.rule.label]
95
-
* 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 `[*]`.
96
-
97
-
The rule name can be clicked to link to that rule.
98
-
99
-
> [!WARNING]
100
-
> 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.
101
-
102
-
* 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].
103
-
104
-
Linking rules to tests is an ongoing effort. See the [Test summary](test-summary.md) chapter for an overview.
105
-
106
48
## Contributing
107
49
108
50
We welcome contributions of all kinds.
@@ -112,7 +54,6 @@ You can contribute to this book by opening an issue or sending a pull request to
112
54
[book]: ../book/index.html
113
55
[cargo book]: ../cargo/index.html
114
56
[cargo reference]: ../cargo/reference/index.html
115
-
[example rule]: example.rule.label
116
57
[expressions chapter]: expressions.html
117
58
[file an issue]: https://github.com/rust-lang/reference/issues
0 commit comments