Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

rustdoc should link to its current version of the rustdoc book #131971

Closed
lolbinarycat opened this issue Oct 20, 2024 · 5 comments · Fixed by #134807
Closed

rustdoc should link to its current version of the rustdoc book #131971

lolbinarycat opened this issue Oct 20, 2024 · 5 comments · Fixed by #134807
Assignees
@poliorcetics
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@lolbinarycat
Copy link
Contributor

lolbinarycat commented Oct 20, 2024 •
edited by rustbot
Loading

currently, rustdoc just links to https://doc.rust-lang.org/rustdoc/

this could lead to confusion for old crates on docs.rs when someone tries to use a new feature and it doesn't work.

perhaps, rustdoc 1.80.1 should link to https://doc.rust-lang.org/1.80.1/rustdoc/ and other versions should link to their matching documentation...
@lolbinarycat lolbinarycat added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 20, 2024
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Oct 20, 2024
@Noratrieb Noratrieb removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Nov 9, 2024
@fmease fmease added C-enhancement Category: An issue proposing an enhancement or a PR with one. A-rustdoc-ui Area: Rustdoc UI (generated HTML) labels Dec 6, 2024
@fmease
Copy link
Member

fmease commented Dec 6, 2024

rustdoc just links to […]

I assume you're referring to the first paragraph of the help dropdown?

You can find more information in the rustdoc book.

@lolbinarycat
Copy link
Contributor Author

yes

@poliorcetics
Copy link
Contributor

poliorcetics commented Dec 26, 2024 •
edited
Loading

Wasn't it already done a while ago: 2f1939a ?

EDIT: It was only partially done, it hasn't been updated everywhere

@poliorcetics
Copy link
Contributor

@rustbot claim

@poliorcetics poliorcetics mentioned this issue Dec 26, 2024
Merged
@camelid
Copy link
Member

camelid commented Feb 3, 2025

The linked PR somewhat addresses this, though because docs.rs uses nightly rustdoc, all the doc.rust-lang.org links will be /nightly/... rather than a specific version. However, there's not really anything more we can do from the linking side of things because nightly versions are (of course) unstable and not finalized and thus aren't posted under their version number on doc.rust-lang.org. I don't think this is a particularly big issue though, so it seems reasonable to me to consider this resolved with the PR.

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Feb 3, 2025
@matthiaskrgr
Rollup merge of rust-lang#134807 - poliorcetics:ab/push-skpynvsmwkll,…
e25f9fc 
… r=camelid

fix(rustdoc): always use a channel when linking to doc.rust-lang.org

Closes rust-lang#131971

I manually checked the resulting links

One issue is that this will create `nightly/...` links in places that formerly linked to stable, is that ok ? (the `slice` and `array` links in the search help notably)
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Feb 3, 2025
@matthiaskrgr
Rollup merge of rust-lang#134807 - poliorcetics:ab/push-skpynvsmwkll,…
dcc1acf 
… r=camelid

fix(rustdoc): always use a channel when linking to doc.rust-lang.org

Closes rust-lang#131971

I manually checked the resulting links

One issue is that this will create `nightly/...` links in places that formerly linked to stable, is that ok ? (the `slice` and `array` links in the search help notably)
jieyouxu added a commit to jieyouxu/rust that referenced this issue Feb 3, 2025
@jieyouxu
Rollup merge of rust-lang#134807 - poliorcetics:ab/push-skpynvsmwkll,…
8ba9efd 
… r=camelid

fix(rustdoc): always use a channel when linking to doc.rust-lang.org

Closes rust-lang#131971

I manually checked the resulting links

One issue is that this will create `nightly/...` links in places that formerly linked to stable, is that ok ? (the `slice` and `array` links in the search help notably)
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Feb 3, 2025
@matthiaskrgr
Rollup merge of rust-lang#134807 - poliorcetics:ab/push-skpynvsmwkll,…
50a5c59 
… r=camelid

fix(rustdoc): always use a channel when linking to doc.rust-lang.org

Closes rust-lang#131971

I manually checked the resulting links

One issue is that this will create `nightly/...` links in places that formerly linked to stable, is that ok ? (the `slice` and `array` links in the search help notably)
@bors bors closed this as completed in f8f31fa Feb 4, 2025
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Feb 4, 2025
@rust-timer
Unrolled build for rust-lang#134807
fe08a88 
Rollup merge of rust-lang#134807 - poliorcetics:ab/push-skpynvsmwkll, r=camelid

fix(rustdoc): always use a channel when linking to doc.rust-lang.org

Closes rust-lang#131971

I manually checked the resulting links

One issue is that this will create `nightly/...` links in places that formerly linked to stable, is that ok ? (the `slice` and `array` links in the search help notably)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@poliorcetics poliorcetics

Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(rustdoc): always use a channel when linking to doc.rust-lang.org poliorcetics/rust
6 participants
@poliorcetics @fmease @lolbinarycat @camelid @rustbot @Noratrieb