Skip to content

Commit 2a1f8bc

Browse files
authoredNov 6, 2023
Rollup merge of #117631 - smarnach:error-request-doc-fix, r=ChrisDenton
Documentation cleanup for core::error::Request. This part of the documentation currently render like this: ![image](https://github.com/rust-lang/rust/assets/249196/b34cb907-4ce4-4e85-beca-510d8aa1fefb) The new version renders like this: ![image](https://github.com/rust-lang/rust/assets/249196/fe18398a-15fb-42a7-82a4-f1856d48bd79) Fixes: * Add missing closing back tick. * Remove spurious double back ticks. * Add missing newline to render bullet point correctly. * Fix grammar "there are methods calledrequest_ref and request_value are available" -> "there are methods calledrequest_ref and request_value". * Change "methods" to "functions", which seems more appropriate for free functions.
2 parents 8a34fea + 3a096e9 commit 2a1f8bc

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed
 

‎library/core/src/error.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -439,10 +439,10 @@ where
439439
/// * A Producer initializes the value of one of its fields of a specific type. (or is otherwise
440440
/// prepared to generate a value requested). eg, `backtrace::Backtrace` or
441441
/// `std::backtrace::Backtrace`
442-
/// * A Consumer requests an object of a specific type (say `std::backtrace::Backtrace). In the case
443-
/// of a `dyn Error` trait object (the Producer), there are methods called `request_ref` and
444-
/// `request_value` are available to simplify obtaining an ``Option<T>`` for a given type. * The
445-
/// Producer, when requested, populates the given Request object which is given as a mutable
442+
/// * A Consumer requests an object of a specific type (say `std::backtrace::Backtrace`). In the
443+
/// case of a `dyn Error` trait object (the Producer), there are functions called `request_ref` and
444+
/// `request_value` to simplify obtaining an `Option<T>` for a given type.
445+
/// * The Producer, when requested, populates the given Request object which is given as a mutable
446446
/// reference.
447447
/// * The Consumer extracts a value or reference to the requested type from the `Request` object
448448
/// wrapped in an `Option<T>`; in the case of `dyn Error` the aforementioned `request_ref` and `

0 commit comments

Comments
 (0)
Please sign in to comment.