Skip to content

std::error::Request: clean up documentation#155467

Merged
rust-bors[bot] merged 2 commits intorust-lang:mainfrom
DanielEScherzer:patch-2
Apr 18, 2026
Merged

std::error::Request: clean up documentation#155467
rust-bors[bot] merged 2 commits intorust-lang:mainfrom
DanielEScherzer:patch-2

Conversation

@DanielEScherzer
Copy link
Copy Markdown
Contributor

@DanielEScherzer DanielEScherzer commented Apr 17, 2026 •
edited
Loading

@rustbot label +A-docs

@DanielEScherzer
std::error::Request: add missing period in docs
6525e06 
All but one of the bullet points ended with a period; add the missing period.
@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Apr 17, 2026
@rustbot
Copy link
Copy Markdown
Collaborator

rustbot commented Apr 17, 2026

r? @Mark-Simulacrum

rustbot has assigned @Mark-Simulacrum.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Why was this reviewer chosen?

The reviewer was selected based on:

  • Owners of files modified in this PR: @scottmcm, libs
  • @scottmcm, libs expanded to 7 candidates
  • Random selection from Mark-Simulacrum, jhpratt

@rustbot rustbot added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Apr 17, 2026
@mejrs
Copy link
Copy Markdown
Contributor

mejrs commented Apr 17, 2026 •
edited
Loading

r? me

I've taken a look at the docs and I notice some more of these small typos and inconsistencies in the docs (https://doc.rust-lang.org/nightly/core/error/struct.Request.html).

For example, use of eg., eg instead of e.g., request_value (notice the leading space), the braces in this line are weird

The motivating and prototypical use case is core::error::Error which would otherwise require a method per concrete type (eg. std::backtrace::Backtrace instance that implementors want to expose to users).

Would you be able to tackle these as well? Maybe there's more I'm missing here too.

@rustbot rustbot assigned mejrs and unassigned Mark-Simulacrum Apr 17, 2026
@DanielEScherzer
Copy link
Copy Markdown
Contributor Author

DanielEScherzer commented Apr 17, 2026

Would you be able to tackle these as well? Maybe there's more I'm missing here too.

Sure, did those and a few more. At some point I'm planning to try and do eg tree-wide (c.f. #153319)

@DanielEScherzer DanielEScherzer changed the title std::error::Request: add missing period in docs std::error::Request: clean up documentation Apr 17, 2026
@mejrs
Copy link
Copy Markdown
Contributor

mejrs commented Apr 17, 2026

Thanks!

As an aside, I really hate phrases like e.g. and ex. and would rather rewrite docs so I don't need them. But that work is not for today.

@bors r+ rollup

@rust-bors
Copy link
Copy Markdown
Contributor

rust-bors Bot commented Apr 17, 2026

📌 Commit 1d1aa9a has been approved by mejrs

It is now in the queue for this repository.

@rust-bors rust-bors Bot added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 17, 2026
mejrs
mejrs approved these changes Apr 17, 2026 •
edited
Loading
View reviewed changes
jhpratt added a commit to jhpratt/rust that referenced this pull request Apr 18, 2026
@jhpratt
Rollup merge of rust-lang#155467 - DanielEScherzer:patch-2, r=mejrs
34c45fc 
`std::error::Request`: clean up documentation
This was referenced Apr 18, 2026
Closed
Merged
rust-bors Bot pushed a commit that referenced this pull request Apr 18, 2026
@bors
Auto merge of #155472 - jhpratt:rollup-cFOYOWJ, r=jhpratt
7a38981 
Rollup of 12 pull requests

Successful merges:

 - #147811 (naked functions: respect `function-sections`)
 - #154935 (Add Sized supertrait for CoerceUnsized and DispatchFromDyn)
 - #139690 (`impl Default for RepeatN`)
 - #153511 (`std::any::TypeId`: remove misplaced "and" in `Unique<T>` example)
 - #154943 (Move recursion out of `MatchPairTree::for_pattern` helpers )
 - #155295 (Fix misleading "borrowed data escapes outside of function" diagnostic)
 - #155427 (ptr: update text in intro text to one in with_addr doc)
 - #155428 (Fix ICE in borrowck mutability suggestion with multi-byte ref sigil)
 - #155435 (rustdoc: Fix `redundant_explicit_links` incorrectly firing (or not firing) under certain scenarios)
 - #155450 (Remove unnecessary safety conditions related to unchecked uint arithmetic)
 - #155454 (docs: Fix typo in std/src/thready/scoped.rs)
 - #155467 (`std::error::Request`: clean up documentation)
@rust-bors rust-bors Bot merged commit 0bfd952 into rust-lang:main Apr 18, 2026
11 checks passed
rust-timer added a commit that referenced this pull request Apr 18, 2026
@rust-timer
Unrolled build for #155467
468b955 
Rollup merge of #155467 - DanielEScherzer:patch-2, r=mejrs

`std::error::Request`: clean up documentation
@rustbot rustbot added this to the 1.97.0 milestone Apr 18, 2026
@DanielEScherzer DanielEScherzer deleted the patch-2 branch April 18, 2026 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mejrs mejrs mejrs approved these changes

Assignees

@mejrs mejrs

Labels

A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.97.0

Development

Successfully merging this pull request may close these issues.

4 participants

@DanielEScherzer @rustbot @mejrs @Mark-Simulacrum