chore: typographic improvements (#6262)

This commit is contained in:
Alice Ryhl
2024-01-03 18:01:27 +00:00
committed by GitHub
parent 7c606ab44a
commit c7e7f203ee
5 changed files with 12 additions and 11 deletions
+5 -5
View File
@@ -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
///
@@ -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
///
@@ -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
///
@@ -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
///
@@ -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
///
+1 -1
View File
@@ -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
+1 -1
View File
@@ -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.
+1
View File
@@ -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"]
+4 -4
View File
@@ -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.