Skip to content

Comments

DOC: do not link to "nightly" in Iterator::by_ref() docstring#152818

Merged
rust-bors[bot] merged 1 commit intorust-lang:mainfrom
mgeier:doc-by_ref-link
Feb 20, 2026
Merged

DOC: do not link to "nightly" in Iterator::by_ref() docstring#152818
rust-bors[bot] merged 1 commit intorust-lang:mainfrom
mgeier:doc-by_ref-link

Conversation

@mgeier
Copy link
Contributor

@mgeier mgeier commented Feb 18, 2026

I happened to see that the link in the docstring https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.by_ref points to the "nightly" docs instead of "stable".

I'm not sure if my fix actually works because I didn't get cargo doc to run on my local computer.

@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 Feb 18, 2026
@rustbot
Copy link
Collaborator

rustbot commented Feb 18, 2026

r? @scottmcm

rustbot has assigned @scottmcm.
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 8 candidates
  • Random selection from Mark-Simulacrum, jhpratt, joboet, scottmcm

Copy link
Member

@SpriteOvO SpriteOvO left a comment

Choose a reason for hiding this comment

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

Tested locally, works fine on both /std and /core paths.

View changes since this review

@SpriteOvO SpriteOvO added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Feb 19, 2026
@asder8215
Copy link
Contributor

I'm not sure if my fix actually works because I didn't get cargo doc to run on my local computer.

You actually run ./x doc --stage 1 library --open to build and open the docs for standard library and test it locally. Hope that works for you.

You can read more about it here:

@scottmcm
Copy link
Member

CI likes it, so sounds good! Thanks.

@bors r+ rollup

@rust-bors
Copy link
Contributor

rust-bors bot commented Feb 19, 2026

📌 Commit 5c64b89 has been approved by scottmcm

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 Feb 19, 2026
jhpratt added a commit to jhpratt/rust that referenced this pull request Feb 20, 2026
DOC: do not link to "nightly" in Iterator::by_ref() docstring

I happened to see that the link in the docstring https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.by_ref points to the "nightly" docs instead of "stable".

I'm not sure if my fix actually works because I didn't get `cargo doc` to run on my local computer.
rust-bors bot pushed a commit that referenced this pull request Feb 20, 2026
Rollup of 7 pull requests

Successful merges:

 - #152057 (bootstrap: respect POSIX jobserver)
 - #152818 (DOC: do not link to "nightly" in Iterator::by_ref() docstring)
 - #152840 (Add bootstrap snapshot tests for {`install`, `install src`})
 - #152846 (Clarify some variable names in the query proc-macro)
 - #152858 (Fix typo in doc for core::mem::type_info::Struct)
 - #152861 (resolve: do not suggest `_` for unresolved imports)
 - #152873 (std::ops::ControlFlow - use "a" before `Result`)
jhpratt added a commit to jhpratt/rust that referenced this pull request Feb 20, 2026
DOC: do not link to "nightly" in Iterator::by_ref() docstring

I happened to see that the link in the docstring https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.by_ref points to the "nightly" docs instead of "stable".

I'm not sure if my fix actually works because I didn't get `cargo doc` to run on my local computer.
rust-bors bot pushed a commit that referenced this pull request Feb 20, 2026
Rollup of 8 pull requests

Successful merges:

 - #152057 (bootstrap: respect POSIX jobserver)
 - #152527 (Remove -Zemit-thin-lto flag)
 - #152818 (DOC: do not link to "nightly" in Iterator::by_ref() docstring)
 - #152840 (Add bootstrap snapshot tests for {`install`, `install src`})
 - #152846 (Clarify some variable names in the query proc-macro)
 - #152858 (Fix typo in doc for core::mem::type_info::Struct)
 - #152861 (resolve: do not suggest `_` for unresolved imports)
 - #152873 (std::ops::ControlFlow - use "a" before `Result`)
rust-bors bot pushed a commit that referenced this pull request Feb 20, 2026
…uwer

Rollup of 11 pull requests

Successful merges:

 - #152759 (Simpler `find_attr!()`)
 - #152057 (bootstrap: respect POSIX jobserver)
 - #152818 (DOC: do not link to "nightly" in Iterator::by_ref() docstring)
 - #152840 (Add bootstrap snapshot tests for {`install`, `install src`})
 - #152844 (Rename `DepGraphQuery` to `RetainedDepGraph`)
 - #152846 (Clarify some variable names in the query proc-macro)
 - #152858 (Fix typo in doc for core::mem::type_info::Struct)
 - #152861 (resolve: do not suggest `_` for unresolved imports)
 - #152873 (std::ops::ControlFlow - use "a" before `Result`)
 - #152877 (std::ops::ControlFlow - use normal comment for internal methods)
 - #152883 (Deny final not followed by item)
@rust-bors rust-bors bot merged commit cfc274c into rust-lang:main Feb 20, 2026
11 checks passed
@rustbot rustbot added this to the 1.95.0 milestone Feb 20, 2026
rust-timer added a commit that referenced this pull request Feb 20, 2026
Rollup merge of #152818 - mgeier:doc-by_ref-link, r=scottmcm

DOC: do not link to "nightly" in Iterator::by_ref() docstring

I happened to see that the link in the docstring https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.by_ref points to the "nightly" docs instead of "stable".

I'm not sure if my fix actually works because I didn't get `cargo doc` to run on my local computer.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

Development

Successfully merging this pull request may close these issues.

5 participants