Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: typographic improvements #6262

Merged
merged 2 commits into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions tokio-stream/src/stream_map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ pub struct StreamMap<K, V> {
impl<K, V> StreamMap<K, V> {
/// An iterator visiting all key-value pairs in arbitrary order.
///
/// The iterator element type is &'a (K, V).
/// The iterator element type is `&'a (K, V)`.
///
/// # Examples
///
Expand All @@ -232,7 +232,7 @@ impl<K, V> StreamMap<K, V> {

/// An iterator visiting all key-value pairs mutably in arbitrary order.
///
/// The iterator element type is &'a mut (K, V).
/// The iterator element type is `&'a mut (K, V)`.
///
/// # Examples
///
Expand Down Expand Up @@ -289,7 +289,7 @@ impl<K, V> StreamMap<K, V> {

/// Returns an iterator visiting all keys in arbitrary order.
///
/// The iterator element type is &'a K.
/// The iterator element type is `&'a K`.
///
/// # Examples
///
Expand All @@ -312,7 +312,7 @@ impl<K, V> StreamMap<K, V> {

/// An iterator visiting all values in arbitrary order.
///
/// The iterator element type is &'a V.
/// The iterator element type is `&'a V`.
///
/// # Examples
///
Expand All @@ -335,7 +335,7 @@ impl<K, V> StreamMap<K, V> {

/// An iterator visiting all values mutably in arbitrary order.
///
/// The iterator element type is &'a mut V.
/// The iterator element type is `&'a mut V`.
///
/// # Examples
///
Expand Down
2 changes: 1 addition & 1 deletion tokio-test/src/stream_mock.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
//! intervals between items.
//!
//! # Usage
//! To use the `StreamMock`, you need to create a builder using[`StreamMockBuilder`]. The builder
//! To use the `StreamMock`, you need to create a builder using [`StreamMockBuilder`]. The builder
//! allows you to enqueue actions such as returning items or waiting for a certain duration.
//!
//! # Example
Expand Down
2 changes: 1 addition & 1 deletion tokio-util/src/task/join_map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ where
/// * `Some((key, Ok(value)))` if one of the tasks in this `JoinMap` has
/// completed. The `value` is the return value of that ask, and `key` is
/// the key associated with the task.
/// * `Some((key, Err(err))` if one of the tasks in this JoinMap` has
/// * `Some((key, Err(err))` if one of the tasks in this `JoinMap` has
/// panicked or been aborted. `key` is the key associated with the task
/// that panicked or was aborted.
/// * `None` if the `JoinMap` is empty.
Expand Down
1 change: 1 addition & 0 deletions tokio/src/io/util/flush.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ pin_project! {
/// A future used to fully flush an I/O object.
///
/// Created by the [`AsyncWriteExt::flush`][flush] function.
///
/// [flush]: crate::io::AsyncWriteExt::flush
#[derive(Debug)]
#[must_use = "futures do nothing unless you `.await` or poll them"]
Expand Down
8 changes: 4 additions & 4 deletions tokio/src/runtime/task/core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -157,10 +157,10 @@ pub(crate) struct Header {
/// Table of function pointers for executing actions on the task.
pub(super) vtable: &'static Vtable,

/// This integer contains the id of the OwnedTasks or LocalOwnedTasks that
/// this task is stored in. If the task is not in any list, should be the
/// id of the list that it was previously in, or `None` if it has never been
/// in any list.
/// This integer contains the id of the `OwnedTasks` or `LocalOwnedTasks`
/// that this task is stored in. If the task is not in any list, should be
/// the id of the list that it was previously in, or `None` if it has never
/// been in any list.
///
/// Once a task has been bound to a list, it can never be bound to another
/// list, even if removed from the first list.
Expand Down
Loading