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 warnings when documenting with --document-private-items #9903

Merged
merged 1 commit into from
Sep 13, 2021

Commits on Sep 11, 2021

  1. Fix warnings when documenting with --document-private-items

    - Use hyperlinks for URLs
    - Fix broken intra-doc links
    
    This doesn't fix the following warning, since I wasn't sure what change
    was appropriate:
    ```
    warning: public documentation for `rustc_process` links to private item `self::core::compiler::Context::primary_packages`
       --> src/cargo/core/compiler/compilation.rs:164:22
        |
    164 |     /// flag), see [`crate::core::compiler::Context::primary_packages`].
        |                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ this item is private
        |
        = note: `#[warn(rustdoc::private_intra_doc_links)]` on by default
        = note: this link resolves only because you passed `--document-private-items`, but will break without
    ```
    
    To avoid noise, this doesn't add an `allow` either.
    jyn514 committed Sep 11, 2021
    Configuration menu
    Copy the full SHA
    bf62ae9 View commit details
    Browse the repository at this point in the history