Skip to content

Commit ae41d45

Browse files
authored
Merge pull request #376 from AZanellato/typo-fixes
Typos and sentence structure fixes
2 parents 4cab868 + faad4c8 commit ae41d45

File tree

4 files changed

+6
-10
lines changed

4 files changed

+6
-10
lines changed

docs/src/concepts/futures.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,7 @@ To sum up: Rust gives us the ability to safely abstract over important propertie
2424

2525
## An easy view of computation
2626

27-
While computation is a subject to write a whole [book](https://computationbook.com/) about, a very simplified view suffices for us:
28-
29-
- computation is a sequence of composable operations
30-
- they can branch based on a decision
31-
- they either run to succession and yield a result, or they can yield an error
27+
While computation is a subject to write a whole [book](https://computationbook.com/) about, a very simplified view suffices for us: A sequence of composable operations which can branch based on a decision, run to succession and yield a result or yield an error
3228

3329
## Deferring computation
3430

@@ -136,11 +132,11 @@ When executing 2 or more of these functions at the same time, our runtime system
136132

137133
## Conclusion
138134

139-
Working from values, we searched for something that expresses *working towards a value available sometime later*. From there, we talked about the concept of polling.
135+
Working from values, we searched for something that expresses *working towards a value available later*. From there, we talked about the concept of polling.
140136

141137
A `Future` is any data type that does not represent a value, but the ability to *produce a value at some point in the future*. Implementations of this are very varied and detailed depending on use-case, but the interface is simple.
142138

143-
Next, we will introduce you to `tasks`, which we need to actually *run* Futures.
139+
Next, we will introduce you to `tasks`, which we will use to actually *run* Futures.
144140

145141
[^1]: Two parties reading while it is guaranteed that no one is writing is always safe.
146142

docs/src/concepts/tasks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Tasks in `async_std` are one of the core abstractions. Much like Rust's `thread`
8080

8181
## Blocking
8282

83-
`Task`s are assumed to run _concurrently_, potentially by sharing a thread of execution. This means that operations blocking an _operating system thread_, such as `std::thread::sleep` or io function from Rust's `std` library will _stop execution of all tasks sharing this thread_. Other libraries (such as database drivers) have similar behaviour. Note that _blocking the current thread_ is not in and by itself bad behaviour, just something that does not mix well with the concurrent execution model of `async-std`. Essentially, never do this:
83+
`Task`s are assumed to run _concurrently_, potentially by sharing a thread of execution. This means that operations blocking an _operating system thread_, such as `std::thread::sleep` or io function from Rust's `std` library will _stop execution of all tasks sharing this thread_. Other libraries (such as database drivers) have similar behaviour. Note that _blocking the current thread_ is not in and of itself bad behaviour, just something that does not mix well with the concurrent execution model of `async-std`. Essentially, never do this:
8484

8585
```rust,edition2018
8686
# extern crate async_std;

docs/src/overview/async-std.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44

55
`async-std` provides an interface to all important primitives: filesystem operations, network operations and concurrency basics like timers. It also exposes a `task` in a model similar to the `thread` module found in the Rust standard lib. But it does not only include I/O primitives, but also `async/await` compatible versions of primitives like `Mutex`.
66

7-
[organization]: https://github.com/async-rs/async-std
7+
[organization]: https://github.com/async-rs

docs/src/overview/stability-guarantees.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In general, this crate will be conservative with respect to the minimum supporte
3131

3232
## Security fixes
3333

34-
Security fixes will be applied to _all_ minor branches of this library in all _supported_ major revisions. This policy might change in the future, in which case we give at least _3 month_ of ahead notice.
34+
Security fixes will be applied to _all_ minor branches of this library in all _supported_ major revisions. This policy might change in the future, in which case we give a notice at least _3 months_ ahead.
3535

3636
## Credits
3737

0 commit comments

Comments
 (0)