Skip to content

Commit 0bfd952

Browse files
authored
Rollup merge of #155467 - DanielEScherzer:patch-2, r=mejrs
`std::error::Request`: clean up documentation
2 parents 4fa293c + 1d1aa9a commit 0bfd952

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

library/core/src/error.rs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -494,37 +494,37 @@ where
494494
/// `Request` supports generic, type-driven access to data. Its use is currently restricted to the
495495
/// standard library in cases where trait authors wish to allow trait implementors to share generic
496496
/// information across trait boundaries. The motivating and prototypical use case is
497-
/// `core::error::Error` which would otherwise require a method per concrete type (eg.
497+
/// `core::error::Error` which would otherwise require a method per concrete type (e.g.
498498
/// `std::backtrace::Backtrace` instance that implementors want to expose to users).
499499
///
500500
/// # Data flow
501501
///
502502
/// To describe the intended data flow for Request objects, let's consider two conceptual users
503503
/// separated by API boundaries:
504504
///
505-
/// * Consumer - the consumer requests objects using a Request instance; eg a crate that offers
505+
/// * Consumer - the consumer requests objects using a Request instance; e.g. a crate that offers
506506
/// fancy `Error`/`Result` reporting to users wants to request a Backtrace from a given `dyn Error`.
507507
///
508-
/// * Producer - the producer provides objects when requested via Request; eg. a library with an
508+
/// * Producer - the producer provides objects when requested via Request; e.g. a library with an
509509
/// an `Error` implementation that automatically captures backtraces at the time instances are
510510
/// created.
511511
///
512-
/// The consumer only needs to know where to submit their request and are expected to handle the
512+
/// The consumer only needs to know where to submit their request and is expected to handle the
513513
/// request not being fulfilled by the use of `Option<T>` in the responses offered by the producer.
514514
///
515515
/// * A Producer initializes the value of one of its fields of a specific type. (or is otherwise
516-
/// prepared to generate a value requested). eg, `backtrace::Backtrace` or
517-
/// `std::backtrace::Backtrace`
516+
/// prepared to generate a value requested). e.g., `backtrace::Backtrace` or
517+
/// `std::backtrace::Backtrace`.
518518
/// * A Consumer requests an object of a specific type (say `std::backtrace::Backtrace`). In the
519519
/// case of a `dyn Error` trait object (the Producer), there are functions called `request_ref` and
520520
/// `request_value` to simplify obtaining an `Option<T>` for a given type.
521521
/// * The Producer, when requested, populates the given Request object which is given as a mutable
522522
/// reference.
523523
/// * The Consumer extracts a value or reference to the requested type from the `Request` object
524-
/// wrapped in an `Option<T>`; in the case of `dyn Error` the aforementioned `request_ref` and `
525-
/// request_value` methods mean that `dyn Error` users don't have to deal with the `Request` type at
524+
/// wrapped in an `Option<T>`; in the case of `dyn Error` the aforementioned `request_ref` and
525+
/// `request_value` methods mean that `dyn Error` users don't have to deal with the `Request` type at
526526
/// all (but `Error` implementors do). The `None` case of the `Option` suggests only that the
527-
/// Producer cannot currently offer an instance of the requested type, not it can't or never will.
527+
/// Producer cannot currently offer an instance of the requested type, not that it can't or never will.
528528
///
529529
/// # Examples
530530
///

0 commit comments

Comments
 (0)