diff --git a/CHANGELOG.md b/CHANGELOG.md index 2209cb2847..86b614f4a6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -102,7 +102,7 @@ * Fixed bug with zero-size buffers in vectored IO (#1998) * `AtomicWaker::new()` is now `const fn` (#2007) * Fixed bug between threadpool and user park/unparking (#2010) -* Added `stream::Peakable::peek` (#2021) +* Added `stream::Peekable::peek` (#2021) * Added `StreamExt::scan` (#2044) * Added impl of `AsyncRead`/`Write` for `BufReader`/`Writer` (#2033) * Added impl of `Spawn` and `LocalSpawn` for `Arc` (#2039) @@ -238,7 +238,7 @@ # 0.3.0-alpha.14 - 2019-4-15 * Updated to new nightly `futures_api`. * Changed `Forward` combinator to drop sink after completion, and allow `!Unpin` `Sink`s. -* Added 0.1 <-> 0.3 compatability shim for `Sink`s. +* Added 0.1 <-> 0.3 compatibility shim for `Sink`s. * Changed `Sink::Item` to a generic parameter `Sink`, allowing `Sink`s to accept multiple different types, including types containing references. * Changed `AsyncRead` and `AsyncWrite` to take `Pin<&mut Self>` rather than `&mut self`. @@ -313,8 +313,8 @@ * `StreamExt::boxed` combinator * Unsoundness fix for `FuturesUnordered` * `StreamObj` (similar to `FutureObj`) -* Code examples for compatiblity layer functions -* Use cargo create renaming feature to import `futures@0.1` for compatiblily layer +* Code examples for compatibility layer functions +* Use cargo create renaming feature to import `futures@0.1` for compatibility layer * Import pinning APIs from `core::pin` * Run Clippy in CI only when it is available @@ -338,7 +338,7 @@ # 0.3.0-alpha.2 - 2018-07-30 * The changelog is back! -* Compatiblity with futures API in latest nightly +* Compatibility with futures API in latest nightly * Code examples and doc improvements - IO: Methods of traits `AsyncReadExt`, `AsyncWriteExt` - Future: @@ -360,7 +360,7 @@ * We now use the unstable `use_extern_macros` feature for macro reexports * CI improvements: Named CI jobs, tests are now run on macOS and Linux, the docs are generated and Clippy needs to pass * `#[deny(warnings)]` was removed from all crates and is now only enforced in the CI -* We now have a naming convention for type paramters: `Fut` future, `F` function, `St` stream, `Si` sink, `S` sink & stream, `R` reader, `W` writer, `T` value, `E` error +* We now have a naming convention for type parameters: `Fut` future, `F` function, `St` stream, `Si` sink, `S` sink & stream, `R` reader, `W` writer, `T` value, `E` error * "Task" is now defined as our term for "lightweight thread". The code of the executors and `FuturesUnordered` was refactored to align with this definition. # 0.3.0-alpha.1 - 2018-07-19 diff --git a/examples/functional/src/main.rs b/examples/functional/src/main.rs index 7dea28d674..2ed8b37c58 100644 --- a/examples/functional/src/main.rs +++ b/examples/functional/src/main.rs @@ -38,7 +38,7 @@ fn main() { }; // Actually execute the above future, which will invoke Future::poll and - // subsequenty chain appropriate Future::poll and methods needing executors + // subsequently chain appropriate Future::poll and methods needing executors // to drive all futures. Eventually fut_values will be driven to completion. let values: Vec = executor::block_on(fut_values); diff --git a/examples/imperative/src/main.rs b/examples/imperative/src/main.rs index 10ef7f4df5..44f4153cd9 100644 --- a/examples/imperative/src/main.rs +++ b/examples/imperative/src/main.rs @@ -40,7 +40,7 @@ fn main() { }; // Actually execute the above future, which will invoke Future::poll and - // subsequenty chain appropriate Future::poll and methods needing executors + // subsequently chain appropriate Future::poll and methods needing executors // to drive all futures. Eventually fut_values will be driven to completion. let values: Vec = executor::block_on(fut_values); diff --git a/futures-channel/src/mpsc/mod.rs b/futures-channel/src/mpsc/mod.rs index 0ce13e6dbc..e848feb6bb 100644 --- a/futures-channel/src/mpsc/mod.rs +++ b/futures-channel/src/mpsc/mod.rs @@ -511,7 +511,7 @@ impl BoundedSenderInner { // Do the send without failing. // Can be called only by bounded sender. fn do_send_b(&mut self, msg: T) -> Result<(), TrySendError> { - // Anyone callig do_send *should* make sure there is room first, + // Anyone calling do_send *should* make sure there is room first, // but assert here for tests as a sanity check. debug_assert!(self.poll_unparked(None).is_ready()); diff --git a/futures-executor/src/thread_pool.rs b/futures-executor/src/thread_pool.rs index f2347dbbdf..5e1f586eb8 100644 --- a/futures-executor/src/thread_pool.rs +++ b/futures-executor/src/thread_pool.rs @@ -245,7 +245,7 @@ impl ThreadPoolBuilder { /// Execute closure `f` just prior to shutting down each worker thread. /// /// This hook is intended for bookkeeping and monitoring. - /// The closure `f` will be dropped after the `builder` is droppped + /// The closure `f` will be dropped after the `builder` is dropped /// and all threads in the pool have executed it. /// /// The closure provided will receive an index corresponding to the worker @@ -367,7 +367,7 @@ mod tests { .create() .unwrap(); - // After ThreadPoolBuilder is deconstructed, the tx should be droped + // After ThreadPoolBuilder is deconstructed, the tx should be dropped // so that we can use rx as an iterator. let count = rx.into_iter().count(); assert_eq!(count, 2); diff --git a/futures-executor/tests/local_pool.rs b/futures-executor/tests/local_pool.rs index 56e6daa077..9b1316b998 100644 --- a/futures-executor/tests/local_pool.rs +++ b/futures-executor/tests/local_pool.rs @@ -404,7 +404,7 @@ fn tasks_are_scheduled_fairly() { } // Tests that the use of park/unpark in user-code has no -// effect on the expected behaviour of the executor. +// effect on the expected behavior of the executor. #[test] fn park_unpark_independence() { let mut done = false; diff --git a/futures-test/src/task/mod.rs b/futures-test/src/task/mod.rs index ef6dd1cea4..cec645d9f2 100644 --- a/futures-test/src/task/mod.rs +++ b/futures-test/src/task/mod.rs @@ -1,5 +1,5 @@ // TODO: note that paths like futures_core::task::Context actually get redirected to core::task::Context -// in the redered docs. Is this desirable? If so, should we change the paths here? +// in the rendered docs. Is this desirable? If so, should we change the paths here? // // Also, there is cross crate links in here. They are not going to work anytime soon. Do we put https links // in here? to here: https://rust-lang.github.io/futures-api-docs? The problem is these have a diff --git a/futures-util/src/io/fill_buf.rs b/futures-util/src/io/fill_buf.rs index 19b0d2044c..a1484c0322 100644 --- a/futures-util/src/io/fill_buf.rs +++ b/futures-util/src/io/fill_buf.rs @@ -30,7 +30,7 @@ where let reader = this.reader.take().expect("Polled FillBuf after completion"); match Pin::new(&mut *reader).poll_fill_buf(cx) { - // With polinius it is possible to remove this inner match and just have the correct + // With polonius it is possible to remove this inner match and just have the correct // lifetime of the reference inferred based on which branch is taken Poll::Ready(Ok(_)) => match Pin::new(reader).poll_fill_buf(cx) { Poll::Ready(Ok(slice)) => Poll::Ready(Ok(slice)), diff --git a/futures-util/src/stream/futures_unordered/mod.rs b/futures-util/src/stream/futures_unordered/mod.rs index a25fbe03ef..4a05d8823e 100644 --- a/futures-util/src/stream/futures_unordered/mod.rs +++ b/futures-util/src/stream/futures_unordered/mod.rs @@ -97,7 +97,7 @@ impl LocalSpawn for FuturesUnordered> { // Each task is wrapped in an `Arc` and thereby atomically reference counted. // Also, each task contains an `AtomicBool` which acts as a flag that indicates // whether the task is currently inserted in the atomic queue. When a wake-up -// notifiaction is received, the task will only be inserted into the ready to +// notification is received, the task will only be inserted into the ready to // run queue if it isn't inserted already. impl Default for FuturesUnordered { diff --git a/futures-util/src/stream/try_stream/try_chunks.rs b/futures-util/src/stream/try_stream/try_chunks.rs index ac10df2114..07d4425a81 100644 --- a/futures-util/src/stream/try_stream/try_chunks.rs +++ b/futures-util/src/stream/try_stream/try_chunks.rs @@ -111,7 +111,7 @@ where /// Error indicating, that while chunk was collected inner stream produced an error. /// -/// Contains all items that were collected before an error occured, and the stream error itself. +/// Contains all items that were collected before an error occurred, and the stream error itself. #[derive(PartialEq, Eq)] pub struct TryChunksError(pub Vec, pub E); diff --git a/futures/src/lib.rs b/futures/src/lib.rs index 468cef7e58..ff9a45993e 100644 --- a/futures/src/lib.rs +++ b/futures/src/lib.rs @@ -67,7 +67,7 @@ //! }; //! //! // Actually execute the above future, which will invoke Future::poll and -//! // subsequenty chain appropriate Future::poll and methods needing executors +//! // subsequently chain appropriate Future::poll and methods needing executors //! // to drive all futures. Eventually fut_values will be driven to completion. //! let values: Vec = executor::block_on(fut_values); //! diff --git a/futures/tests/try_join.rs b/futures/tests/try_join.rs index 8b0b38c1a3..0281ab897d 100644 --- a/futures/tests/try_join.rs +++ b/futures/tests/try_join.rs @@ -3,7 +3,7 @@ use futures::{executor::block_on, try_join}; // TODO: This abuses https://github.com/rust-lang/rust/issues/58733 in order to -// test behaviour of the `try_join!` macro with the never type before it is +// test behavior of the `try_join!` macro with the never type before it is // stabilized. Once `!` is again stabilized this can be removed and replaced // with direct use of `!` below where `Never` is used. trait MyTrait {