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

Fix three rustdoc::broken_intra_doc_links #3192

Merged
merged 1 commit into from
May 30, 2022

Conversation

Enselic
Copy link
Contributor

@Enselic Enselic commented May 27, 2022

I am working on a bit on rust-lang/rust#93588 and found these warnings distracting, so I decided to help fix them.

Step-by-step:

  1. cargo +nightly doc --manifest-path diesel/Cargo.toml

Expected result:

No warnings

Actual result:

warning: unresolved link to `alias`
  --> diesel/src/query_source/aliasing/alias.rs:16:10
   |
16 | /// See [alias!] for more details.
   |          ^^^^^^ no item named `alias` in scope
   |
   = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
   = note: `macro_rules` named `alias` exists in this crate, but it is not in scope at this link's location

warning: unresolved link to `alias`
  --> diesel/src/query_source/aliasing/aliased_field.rs:19:10
   |
19 | /// See [alias!] for more details.
   |          ^^^^^^ no item named `alias` in scope
   |
   = note: `macro_rules` named `alias` exists in this crate, but it is not in scope at this link's location

warning: unresolved link to `allow_tables_to_appear_in_same_query`
    --> diesel/src/macros/mod.rs:1132:28
     |
1132 | /// still need to invoke [`allow_tables_to_appear_in_same_query!`] for these two tables to
     |                            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `allow_tables_to_appear_in_same_query` in scope
     |
     = note: `macro_rules` named `allow_tables_to_appear_in_same_query` exists in this crate, but it is not in scope at this link's location

Step-by-step:
1. `cargo +nightly doc --manifest-path diesel/Cargo.toml`

Expected result:
No warnings

Actual result:
Three warnings
@weiznich weiznich requested a review from a team May 27, 2022 19:50
Copy link
Member

@JohnTitor JohnTitor left a comment

Choose a reason for hiding this comment

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

Thanks! Looks good.

@weiznich weiznich merged commit 3488dbd into diesel-rs:master May 30, 2022
@Enselic Enselic deleted the fix-three-broken-intra-doc-links branch May 31, 2022 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants