Skip to content

Commit 6683251

Browse files
committed
Merge pull request #20902 from stevencrockett/master
reference: Small grammar fixes for correctness/consistency and updates for language changes. Reviewed-by: steveklabnik
2 parents 6773651 + e7e308f commit 6683251

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

src/doc/reference.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -603,7 +603,7 @@ mod b {
603603
```
604604

605605
* Paths starting with the keyword `super` begin resolution relative to the
606-
parent module. Each further identifier must resolve to an item
606+
parent module. Each further identifier must resolve to an item.
607607

608608
```rust
609609
mod a {
@@ -985,7 +985,7 @@ top of [modules](#modules) and [blocks](#blocks).
985985
986986
Use declarations support a number of convenient shortcuts:
987987

988-
* Rebinding the target name as a new local name, using the syntax `use p::q::r as x;`.
988+
* Rebinding the target name as a new local name, using the syntax `use p::q::r as x;`
989989
* Simultaneously binding a list of paths differing only in their final element,
990990
using the glob-like brace syntax `use a::b::{c,d,e,f};`
991991
* Binding all paths matching a given prefix, using the asterisk wildcard syntax
@@ -1091,7 +1091,7 @@ set of *input* [*slots*](#memory-slots) as parameters, through which the caller
10911091
passes arguments into the function, and an *output* [*slot*](#memory-slots)
10921092
through which the function passes results back to the caller.
10931093

1094-
A function may also be copied into a first class *value*, in which case the
1094+
A function may also be copied into a first-class *value*, in which case the
10951095
value has the corresponding [*function type*](#function-types), and can be used
10961096
otherwise exactly as a function item (with a minor additional cost of calling
10971097
the function indirectly).
@@ -1224,7 +1224,7 @@ the guarantee that these issues are never caused by safe code.
12241224
* A value other than `false` (0) or `true` (1) in a `bool`
12251225
* A discriminant in an `enum` not included in the type definition
12261226
* A value in a `char` which is a surrogate or above `char::MAX`
1227-
* non-UTF-8 byte sequences in a `str`
1227+
* Non-UTF-8 byte sequences in a `str`
12281228
* Unwinding into Rust from foreign code or unwinding from Rust into foreign
12291229
code. Rust's failure system is not compatible with exception handling in
12301230
other languages. Unwinding must be caught and handled at FFI boundaries.
@@ -1827,7 +1827,7 @@ accesses in two cases:
18271827

18281828
These two cases are surprisingly powerful for creating module hierarchies
18291829
exposing public APIs while hiding internal implementation details. To help
1830-
explain, here's a few use cases and what they would entail.
1830+
explain, here's a few use cases and what they would entail:
18311831

18321832
* A library developer needs to expose functionality to crates which link
18331833
against their library. As a consequence of the first case, this means that
@@ -1858,7 +1858,7 @@ import/expression is only valid if the destination is in the current visibility
18581858
scope.
18591859

18601860
Here's an example of a program which exemplifies the three cases outlined
1861-
above.
1861+
above:
18621862

18631863
```
18641864
// This module is private, meaning that no external crate can access this
@@ -2213,7 +2213,7 @@ mod m1 {
22132213
```
22142214

22152215
This example shows how one can use `allow` and `warn` to toggle a particular
2216-
check on and off.
2216+
check on and off:
22172217

22182218
```{.ignore}
22192219
#[warn(missing_docs)]
@@ -2235,7 +2235,7 @@ mod m2{
22352235
```
22362236

22372237
This example shows how one can use `forbid` to disallow uses of `allow` for
2238-
that lint check.
2238+
that lint check:
22392239

22402240
```{.ignore}
22412241
#[forbid(missing_docs)]
@@ -2318,9 +2318,9 @@ These language items are traits:
23182318
* `ord`
23192319
: Elements have a partial ordering.
23202320
* `deref`
2321-
: `*` can be applied, yielding a reference to another type
2321+
: `*` can be applied, yielding a reference to another type.
23222322
* `deref_mut`
2323-
: `*` can be applied, yielding a mutable reference to another type
2323+
: `*` can be applied, yielding a mutable reference to another type.
23242324

23252325
These are functions:
23262326

@@ -2341,7 +2341,7 @@ These are functions:
23412341
* `type_id`
23422342
: The type returned by the `type_id` intrinsic.
23432343
* `unsafe`
2344-
: A type whose contents can be mutated through an immutable reference
2344+
: A type whose contents can be mutated through an immutable reference.
23452345

23462346
#### Marker types
23472347

@@ -2350,11 +2350,11 @@ These types help drive the compiler's analysis
23502350
* `begin_unwind`
23512351
: ___Needs filling in___
23522352
* `no_copy_bound`
2353-
: This type does not implement "copy", even if eligible
2353+
: This type does not implement "copy", even if eligible.
23542354
* `no_send_bound`
2355-
: This type does not implement "send", even if eligible
2355+
: This type does not implement "send", even if eligible.
23562356
* `no_sync_bound`
2357-
: This type does not implement "sync", even if eligible
2357+
: This type does not implement "sync", even if eligible.
23582358
* `eh_personality`
23592359
: ___Needs filling in___
23602360
* `exchange_free`
@@ -2376,11 +2376,11 @@ These types help drive the compiler's analysis
23762376
* `iterator`
23772377
: ___Needs filling in___
23782378
* `contravariant_lifetime`
2379-
: The lifetime parameter should be considered contravariant
2379+
: The lifetime parameter should be considered contravariant.
23802380
* `covariant_lifetime`
2381-
: The lifetime parameter should be considered covariant
2381+
: The lifetime parameter should be considered covariant.
23822382
* `invariant_lifetime`
2383-
: The lifetime parameter should be considered invariant
2383+
: The lifetime parameter should be considered invariant.
23842384
* `malloc`
23852385
: Allocate memory on the managed heap.
23862386
* `owned_box`
@@ -2390,11 +2390,11 @@ These types help drive the compiler's analysis
23902390
* `start`
23912391
: ___Needs filling in___
23922392
* `contravariant_type`
2393-
: The type parameter should be considered contravariant
2393+
: The type parameter should be considered contravariant.
23942394
* `covariant_type`
2395-
: The type parameter should be considered covariant
2395+
: The type parameter should be considered covariant.
23962396
* `invariant_type`
2397-
: The type parameter should be considered invariant
2397+
: The type parameter should be considered invariant.
23982398
* `ty_desc`
23992399
: ___Needs filling in___
24002400

@@ -3219,11 +3219,11 @@ the simplest and least-expensive form (analogous to a ```|| { }``` expression),
32193219
the lambda expression captures its environment by reference, effectively
32203220
borrowing pointers to all outer variables mentioned inside the function.
32213221
Alternately, the compiler may infer that a lambda expression should copy or
3222-
move values (depending on their type.) from the environment into the lambda
3222+
move values (depending on their type) from the environment into the lambda
32233223
expression's captured environment.
32243224

32253225
In this example, we define a function `ten_times` that takes a higher-order
3226-
function argument, and call it with a lambda expression as an argument.
3226+
function argument, and call it with a lambda expression as an argument:
32273227

32283228
```
32293229
fn ten_times<F>(f: F) where F: Fn(int) {
@@ -3661,14 +3661,14 @@ within an object along with one byte past the end.
36613661
The types `char` and `str` hold textual data.
36623662

36633663
A value of type `char` is a [Unicode scalar value](
3664-
http://www.unicode.org/glossary/#unicode_scalar_value) (ie. a code point that
3664+
http://www.unicode.org/glossary/#unicode_scalar_value) (i.e. a code point that
36653665
is not a surrogate), represented as a 32-bit unsigned word in the 0x0000 to
36663666
0xD7FF or 0xE000 to 0x10FFFF range. A `[char]` array is effectively an UCS-4 /
36673667
UTF-32 string.
36683668

36693669
A value of type `str` is a Unicode string, represented as an array of 8-bit
36703670
unsigned bytes holding a sequence of UTF-8 codepoints. Since `str` is of
3671-
unknown size, it is not a _first class_ type, but can only be instantiated
3671+
unknown size, it is not a _first-class_ type, but can only be instantiated
36723672
through a pointer type, such as `&str` or `String`.
36733673

36743674
### Tuple types
@@ -3698,7 +3698,7 @@ assert!(b != "world");
36983698

36993699
Rust has two different types for a list of items:
37003700

3701-
* `[T ..N]`, an 'array'
3701+
* `[T; N]`, an 'array'.
37023702
* `&[T]`, a 'slice'.
37033703

37043704
An array has a fixed size, and can be allocated on either the stack or the
@@ -3710,9 +3710,9 @@ to, it borrows it.
37103710
An example of each kind:
37113711

37123712
```{rust}
3713-
let vec: Vec<int> = vec![1, 2, 3];
3714-
let arr: [int; 3] = [1, 2, 3];
3715-
let s: &[int] = vec.as_slice();
3713+
let vec: Vec<i32> = vec![1, 2, 3];
3714+
let arr: [i32; 3] = [1, 2, 3];
3715+
let s: &[i32] = vec.as_slice();
37163716
```
37173717

37183718
As you can see, the `vec!` macro allows you to create a `Vec<T>` easily. The
@@ -3798,7 +3798,7 @@ enum List<T> {
37983798
Cons(T, Box<List<T>>)
37993799
}
38003800
3801-
let a: List<int> = List::Cons(7, Box::new(List::Cons(13, Box::new(List::Nil))));
3801+
let a: List<i32> = List::Cons(7, Box::new(List::Cons(13, Box::new(List::Nil))));
38023802
```
38033803

38043804
### Pointer types

0 commit comments

Comments
 (0)