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.

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

resolve: Fix doc links referring to other crates when documenting proc macro crates directly #107951

Merged
merged 1 commit into from
Feb 19, 2023

Conversation

petrochenkov
Copy link
Contributor

Fixes #107950

@rustbot
Copy link
Collaborator

rustbot commented Feb 12, 2023

r? @jackh726

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Feb 12, 2023
extern crate proc_macro;
use proc_macro::*;

// has core/marker/trait.Unpin.html
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure what to write here,

// @has core/marker/trait.Unpin.html

doesn't work and reports

8: @has check failed
        File does not exist 'core\\marker\\trait.Unpin.html'
        // @has core/marker/trait.Unpin.html

because dependency crates like libcore are not documented in the test suite.

Copy link
Contributor

@eggyal eggyal Feb 12, 2023

Choose a reason for hiding this comment

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

You could instead add an aux crate to the test (with aux-build and build-aux-docs compiletest headers), and use a link to that instead? Or else perhaps just make it a rustdoc-ui test with #![deny(rustdoc::broken_intra_doc_links)] ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, moved to rustdoc-ui.

@jackh726
Copy link
Member

@bors r+

@bors
Copy link
Contributor

bors commented Feb 18, 2023

📌 Commit efbf654 has been approved by jackh726

It is now in the queue for this repository.

@bors bors 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 18, 2023
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 19, 2023
Rollup of 7 pull requests

Successful merges:

 - rust-lang#104659 (reflow the stack size story)
 - rust-lang#106933 (Update documentation of select_nth_unstable and select_nth_unstable_by to state O(n^2) complexity)
 - rust-lang#107783 (rustdoc: simplify DOM for `.item-table`)
 - rust-lang#107951 (resolve: Fix doc links referring to other crates when documenting proc macro crates directly)
 - rust-lang#108130 ("Basic usage" is redundant for there is just one example)
 - rust-lang#108146 (rustdoc: hide `reference` methods in search index)
 - rust-lang#108189 (Fix some more `non_lifetime_binders` stuff with higher-ranked trait bounds)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 4a0f088 into rust-lang:master Feb 19, 2023
@rustbot rustbot added this to the 1.69.0 milestone Feb 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

rustdoc regression: intra-doc-links not working in proc-macro crate since nightly-2023-02-12
5 participants