Skip to content

Commit 1ec735f

Browse files
committed
Say "use" rather than "usage" in the syntax index
In each table in the syntax index, we have some bit of syntax on the left and then on the right we have features in which that bit of syntax is used. Should we title the column on the right "use" (or maybe "uses") or "usage"? One could almost, superficially, make a case for "usage". As relevant here, Webster's defines it as "the way in which a word, phrase, etc. is used to express a particular idea". That sounds close. The trouble is that it's nearly the wrong way around. The "idea" here is actually the thing on the right. The "usage" would be the place or way in which the syntax is used to express that idea. Conversely, definitions of "use" apply cleanly: to "employ for or apply to a given purpose", "an instance or way of using", etc. As Garner says: > Whenever *use* is possible, *usage* shouldn't appear. Let's say "use".
1 parent bd1d0c3 commit 1ec735f

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

src/syntax-index.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ This appendix provides an index of tokens and common forms with links to where t
44

55
## Keywords
66

7-
| Keyword | Usage |
8-
|---------------|-------|
7+
| Keyword | Use |
8+
|---------------|-----|
99
| `_` | [wildcard pattern], [inferred const], [inferred type], [placeholder lifetime], [constant items], [extern crate], [use declarations], [destructuring assignment] |
1010
| `abstract` | [reserved keyword] |
1111
| `as` | [extern crate][items.extern-crate.as], [use declarations][items.use.forms.as], [type cast expressions], [qualified paths] |
@@ -66,8 +66,8 @@ This appendix provides an index of tokens and common forms with links to where t
6666

6767
## Operators and punctuation
6868

69-
| Symbol | Name | Usage |
70-
|--------|-------------|-------|
69+
| Symbol | Name | Use |
70+
|--------|-------------|-----|
7171
| `+` | Plus | [addition][arith], [trait bounds], [macro Kleene matcher] |
7272
| `-` | Minus | [subtraction][arith], [negation] |
7373
| `*` | Star | [multiplication][arith], [dereference], [raw pointers], [macro Kleene matcher], [glob imports] |
@@ -117,8 +117,8 @@ This appendix provides an index of tokens and common forms with links to where t
117117

118118
## Comments
119119

120-
| Comment | Usage |
121-
|----------|-------|
120+
| Comment | Use |
121+
|----------|-----|
122122
| `//` | [line comment][comments] |
123123
| `//!` | [inner line comment][comments] |
124124
| `///` | [outer line doc comment][comments] |
@@ -128,8 +128,8 @@ This appendix provides an index of tokens and common forms with links to where t
128128

129129
## Other tokens
130130

131-
| Token | Usage |
132-
|--------------|-------|
131+
| Token | Use |
132+
|--------------|-----|
133133
| `ident` | [identifiers] |
134134
| `r#ident` | [raw identifiers] |
135135
| `'ident` | [lifetimes and loop labels] |
@@ -146,24 +146,24 @@ This appendix provides an index of tokens and common forms with links to where t
146146

147147
## Macros
148148

149-
| Syntax | Usage |
150-
|--------------------------------------------|-------|
149+
| Syntax | Use |
150+
|--------------------------------------------|-----|
151151
| `ident!(…)`<br>`ident! {…}`<br>`ident![…]` | [macro invocations] |
152152
| `$ident` | [macro metavariable] |
153153
| `$ident:kind` | [macro matcher fragment specifier] |
154154
| `$(…)…` | [macro repetition] |
155155

156156
## Attributes
157157

158-
| Syntax | Usage |
159-
|------------|-------|
158+
| Syntax | Use |
159+
|------------|-----|
160160
| `#[meta]` | [outer attribute] |
161161
| `#![meta]` | [inner attribute] |
162162

163163
## Expressions
164164

165-
| Expression | Usage |
166-
|---------------------------|-------|
165+
| Expression | Use |
166+
|---------------------------|-----|
167167
| <code>\|\| expr</code><br><code>\|\| -> Type { … }</code> | [closures] |
168168
| `ident::…` | [paths] |
169169
| `::crate_name::…` | [explicit crate paths] |
@@ -204,8 +204,8 @@ This appendix provides an index of tokens and common forms with links to where t
204204

205205
[Items] are the components of a crate.
206206

207-
| Item | Usage |
208-
|-------------------------------|-------|
207+
| Item | Use |
208+
|-------------------------------|-----|
209209
| `mod ident;`<br>`mod ident {…}` | [modules] |
210210
| `use path;` | [use declarations] |
211211
| `fn ident(…) {…}` | [functions] |
@@ -224,8 +224,8 @@ This appendix provides an index of tokens and common forms with links to where t
224224

225225
[Type expressions] are used to refer to types.
226226

227-
| Type | Usage |
228-
|---------------------------------------|-------|
227+
| Type | Use |
228+
|---------------------------------------|-----|
229229
| `bool`, `u8`, `f64`, `str`, `` | [primitive types] |
230230
| `for<…>` | [higher-ranked trait bounds] |
231231
| `T: TraitA + TraitB` | [trait bounds] |
@@ -253,8 +253,8 @@ This appendix provides an index of tokens and common forms with links to where t
253253

254254
[Patterns] are used to match values.
255255

256-
| Pattern | Usage |
257-
|-----------------------------------|-------|
256+
| Pattern | Use |
257+
|-----------------------------------|-----|
258258
| `"foo"`, `'a'`, `123`, `2.4`, … | [literal patterns] |
259259
| `ident` | [identifier patterns] |
260260
| `_` | [wildcard pattern] |

0 commit comments

Comments
 (0)