Skip to content

Tweak Infallible docs - #162098

Merged
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
camsteffen:infallible-docs
Sep 21, 2026
Merged

Tweak Infallible docs#162098
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
camsteffen:infallible-docs

Conversation

@camsteffen

@camsteffen camsteffen commented Aug 31, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Adds a hyperlink to the never type.

I restored a statement that Infallible may be deprecated in a future version. That was (unintentionally?) lost in the stabilization PR.

cc @WaffleLapkin

@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 Aug 31, 2026
@rustbot

rustbot commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator

r? @clarfonthey

rustbot has assigned @clarfonthey.
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: libs
  • libs expanded to 12 candidates
  • Random selection from JohnTitor, Mark-Simulacrum, clarfonthey, joboet, nia-e

@camsteffen camsteffen changed the title Revise Infallible docs Revise Infallible docs Aug 31, 2026
WaffleLapkin
WaffleLapkin reviewed Sep 1, 2026
View reviewed changes

@WaffleLapkin WaffleLapkin left a comment •
edited by rustbot
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm somewhat neutral on this.

The previous version is nice in some ways. Specifically, I think referring to the fact that it's an error type makes sense -- that's how infallible has been used before, and the reason for the name.

View changes since this review

Comment thread library/core/src/convert/mod.rs Outdated
////////////////////////////////////////////////////////////////////////////////

/// The error type for errors that can never happen.
/// An alias to [`!`], the "never" type.

@WaffleLapkin WaffleLapkin Sep 1, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why quotes?

@camsteffen camsteffen Sep 20, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The quotes match the never type docs. I take the quotes to mean "the way the type is spoken, not how it is spelled".

@camsteffen

camsteffen commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

That's a good point. I'm realizing that I tended to not think of Infallible that way - I think of it as merely a stand-in for !. But now that I think about it, it's probably best to preserve the original "error" meaning of the type. I'll try to incorporate that back in.

I do still think the documentation should prioritize "current" Rust users by stating towards the top, not the bottom, that ! is preferred. And I also think it's good to rely on ! docs for long-form explanation of how to use the type because ! docs already include explanations for using it as an error type.

@clarfonthey

clarfonthey commented Sep 2, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

To be clear, I think that we don't need to necessarily remove the notes about being an error type, while still prioritising the fact that ! should be used more broadly.

Plus, it isn't deprecated yet, and won't be for a while.

@clarfonthey

clarfonthey commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

@rustbot author

@rustbot rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 13, 2026
@rustbot

rustbot commented Sep 13, 2026

Copy link
Copy Markdown
Collaborator

Reminder, once the PR becomes ready for a review, use @rustbot ready.

@camsteffen
Tweak Infallible docs
cfe9a3a 
Link to the never type and restore the note about possibly deprecating
in the future.
@camsteffen camsteffen changed the title Revise Infallible docs Tweak Infallible docs Sep 20, 2026
@camsteffen

camsteffen commented Sep 20, 2026

Copy link
Copy Markdown
Contributor Author

I decided on a more conservative change, just keeping with the note at the end of the docs. @rustbot ready

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 20, 2026
@clarfonthey

clarfonthey commented Sep 20, 2026

Copy link
Copy Markdown
Contributor

Looks good to me!

@bors r+ rollup

@rust-bors

rust-bors Bot commented Sep 20, 2026

Copy link
Copy Markdown
Contributor

📌 Commit cfe9a3a has been approved by clarfonthey

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 Sep 20, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 20, 2026
@JonathanBrouwer
Rollup merge of rust-lang#162098 - camsteffen:infallible-docs, r=clar…
c04de5a 
…fonthey

Tweak `Infallible` docs

Adds a hyperlink to the never type.

I restored a statement that `Infallible` may be deprecated in a future version. That was (unintentionally?) lost in the stabilization PR.

cc @WaffleLapkin
This was referenced Sep 20, 2026
Closed
Merged
rust-bors Bot pushed a commit that referenced this pull request Sep 20, 2026
@bors
Auto merge of #163071 - JonathanBrouwer:rollup-ly4BY8L, r=JonathanBro…
fa9ef92 
…uwer

Rollup of 15 pull requests

Successful merges:

 - #162726 (std: fix unix socket address panic on a full sun_path)
 - #163016 (Don't claim that escaping value is a reference in diagnostics)
 - #163040 (Tweak "use array's length as const param" suggestion)
 - #163060 (Point to fields that introduce trait requirements)
 - #163066 (don't mark `f128` as reliable on AIX)
 - #162098 (Tweak `Infallible` docs)
 - #162854 (Add safety section for atomic_load/store)
 - #163015 (add `minicore::ffi::VaList`)
 - #163021 (`va_arg`: pass in `TyAndLayout`)
 - #163036 ([rustdoc] Correctly handle `dyn` trait methods linking for jump to def feature)
 - #163042 (Remove redundant output from suggestion)
 - #163046 (Use verbose suggestion for `const _`)
 - #163050 (Use verbose suggestion for similarly named label suggestion)
 - #163052 (Use verbose suggestion for wrong primitive type names)
 - #163055 (Use the full path of `bug_impl` to avoid bogus errors in rust-analyzer)
rust-bors Bot pushed a commit that referenced this pull request Sep 20, 2026
@bors
Auto merge of #163071 - JonathanBrouwer:rollup-ly4BY8L, r=JonathanBro…
69ac11c 
…uwer

Rollup of 15 pull requests

Successful merges:

 - #162726 (std: fix unix socket address panic on a full sun_path)
 - #163016 (Don't claim that escaping value is a reference in diagnostics)
 - #163040 (Tweak "use array's length as const param" suggestion)
 - #163060 (Point to fields that introduce trait requirements)
 - #163066 (don't mark `f128` as reliable on AIX)
 - #162098 (Tweak `Infallible` docs)
 - #162854 (Add safety section for atomic_load/store)
 - #163015 (add `minicore::ffi::VaList`)
 - #163021 (`va_arg`: pass in `TyAndLayout`)
 - #163036 ([rustdoc] Correctly handle `dyn` trait methods linking for jump to def feature)
 - #163042 (Remove redundant output from suggestion)
 - #163046 (Use verbose suggestion for `const _`)
 - #163050 (Use verbose suggestion for similarly named label suggestion)
 - #163052 (Use verbose suggestion for wrong primitive type names)
 - #163055 (Use the full path of `bug_impl` to avoid bogus errors in rust-analyzer)
rust-bors Bot pushed a commit that referenced this pull request Sep 21, 2026
@bors
Auto merge of #163071 - JonathanBrouwer:rollup-ly4BY8L, r=JonathanBro…
2092fb5 
…uwer

Rollup of 15 pull requests

Successful merges:

 - #162726 (std: fix unix socket address panic on a full sun_path)
 - #163016 (Don't claim that escaping value is a reference in diagnostics)
 - #163040 (Tweak "use array's length as const param" suggestion)
 - #163060 (Point to fields that introduce trait requirements)
 - #163066 (don't mark `f128` as reliable on AIX)
 - #162098 (Tweak `Infallible` docs)
 - #162854 (Add safety section for atomic_load/store)
 - #163015 (add `minicore::ffi::VaList`)
 - #163021 (`va_arg`: pass in `TyAndLayout`)
 - #163036 ([rustdoc] Correctly handle `dyn` trait methods linking for jump to def feature)
 - #163042 (Remove redundant output from suggestion)
 - #163046 (Use verbose suggestion for `const _`)
 - #163050 (Use verbose suggestion for similarly named label suggestion)
 - #163052 (Use verbose suggestion for wrong primitive type names)
 - #163055 (Use the full path of `bug_impl` to avoid bogus errors in rust-analyzer)
rust-bors Bot pushed a commit that referenced this pull request Sep 21, 2026
@bors
Auto merge of #163071 - JonathanBrouwer:rollup-ly4BY8L, r=JonathanBro…
220b36c 
…uwer

Rollup of 15 pull requests

Successful merges:

 - #162726 (std: fix unix socket address panic on a full sun_path)
 - #163016 (Don't claim that escaping value is a reference in diagnostics)
 - #163040 (Tweak "use array's length as const param" suggestion)
 - #163060 (Point to fields that introduce trait requirements)
 - #163066 (don't mark `f128` as reliable on AIX)
 - #162098 (Tweak `Infallible` docs)
 - #162854 (Add safety section for atomic_load/store)
 - #163015 (add `minicore::ffi::VaList`)
 - #163021 (`va_arg`: pass in `TyAndLayout`)
 - #163036 ([rustdoc] Correctly handle `dyn` trait methods linking for jump to def feature)
 - #163042 (Remove redundant output from suggestion)
 - #163046 (Use verbose suggestion for `const _`)
 - #163050 (Use verbose suggestion for similarly named label suggestion)
 - #163052 (Use verbose suggestion for wrong primitive type names)
 - #163055 (Use the full path of `bug_impl` to avoid bogus errors in rust-analyzer)
@rust-bors
rust-bors Bot merged commit badfc6c into rust-lang:main Sep 21, 2026
13 checks passed
@rustbot rustbot added this to the 1.100.0 milestone Sep 21, 2026
rust-bors Bot pushed a commit that referenced this pull request Sep 21, 2026
@bors
Unrolled build for #162098 in rollup 163071
0850095 
Rollup merge of #162098 - camsteffen:infallible-docs, r=clarfonthey

Tweak `Infallible` docs

Adds a hyperlink to the never type.

I restored a statement that `Infallible` may be deprecated in a future version. That was (unintentionally?) lost in the stabilization PR.

cc @WaffleLapkin
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@WaffleLapkin WaffleLapkin WaffleLapkin left review comments

Assignees

@clarfonthey clarfonthey

Labels

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.100.0

Development

Successfully merging this pull request may close these issues.

4 participants

@camsteffen @rustbot @clarfonthey @WaffleLapkin