Skip to content

cargo doc fails due to "redundant explicit link target" #721

@gretchenfrage

Description

@gretchenfrage

On current master (761d36acb069ed335d2f9dfd7a568b8735ec7fec) with Rust 1.82.0 (rustc 1.82.0 (f6e511eec 2024-10-15), cargo 1.82.0 (8f40fc59f 2024-08-21)), running cargo doc fails with the following error (which would have been only a warning had the package not been marked with deny(warnings):

Warning
 Documenting http v1.1.0 (/home/phoenix/repos/h3stuff/http)
error: redundant explicit link target
   --> src/lib.rs:9:20
    |
9   | //! [`HeaderName`][header::HeaderName]/[`HeaderValue`][header::HeaderName] definitions to get grouped in a [`HeaderMap`] to
    |      ------------  ^^^^^^^^^^^^^^^^^^ explicit target is redundant
    |      |
    |      because label contains path that resolves to same destination
    |
    = note: when a link's destination is not specified,
            the label is used to resolve intra-doc links
note: the lint level is defined here
   --> src/lib.rs:159:9
    |
159 | #![deny(warnings, missing_docs, missing_debug_implementations)]
    |         ^^^^^^^^
    = note: `#[deny(rustdoc::redundant_explicit_links)]` implied by `#[deny(warnings)]`
help: remove explicit link target
    |
9   | //! [`HeaderName`]/[`HeaderValue`][header::HeaderName] definitions to get grouped in a [`HeaderMap`] to
    |     ~~~~~~~~~~~~~~

error: redundant explicit link target
  --> src/lib.rs:90:41
   |
90 | //! Then `"Accept"` is a [`HeaderName`][header::HeaderName] while `"text/html"` is a [`HeaderValue`][header::HeaderValue].
   |                           ------------  ^^^^^^^^^^^^^^^^^^ explicit target is redundant
   |                           |
   |                           because label contains path that resolves to same destination
   |
   = note: when a link's destination is not specified,
           the label is used to resolve intra-doc links
help: remove explicit link target
   |
90 | //! Then `"Accept"` is a [`HeaderName`] while `"text/html"` is a [`HeaderValue`][header::HeaderValue].
   |                          ~~~~~~~~~~~~~~

error: redundant explicit link target
  --> src/lib.rs:90:102
   |
90 | //! Then `"Accept"` is a [`HeaderName`][header::HeaderName] while `"text/html"` is a [`HeaderValue`][header::HeaderValue].
   |                                                                                       -------------  ^^^^^^^^^^^^^^^^^^^ explicit target is redundant
   |                                                                                       |
   |                                                                                       because label contains path that resolves to same destination
   |
   = note: when a link's destination is not specified,
           the label is used to resolve intra-doc links
help: remove explicit link target
   |
90 | //! Then `"Accept"` is a [`HeaderName`][header::HeaderName] while `"text/html"` is a [`HeaderValue`].
   |                                                                                      ~~~~~~~~~~~~~~~

error: redundant explicit link target
  --> src/lib.rs:93:30
   |
93 | //! example a [`HeaderName`][header::HeaderName] is always a valid `&str`, but a [`HeaderValue`] may
   |                ------------  ^^^^^^^^^^^^^^^^^^ explicit target is redundant
   |                |
   |                because label contains path that resolves to same destination
   |
   = note: when a link's destination is not specified,
           the label is used to resolve intra-doc links
help: remove explicit link target
   |
93 | //! example a [`HeaderName`] is always a valid `&str`, but a [`HeaderValue`] may
   |               ~~~~~~~~~~~~~~

error: redundant explicit link target
   --> src/lib.rs:137:20
    |
137 | //! [`HeaderName`][header::HeaderName] and generic values. This type, like header names, is optimized
    |      ------------  ^^^^^^^^^^^^^^^^^^ explicit target is redundant
    |      |
    |      because label contains path that resolves to same destination
    |
    = note: when a link's destination is not specified,
            the label is used to resolve intra-doc links
help: remove explicit link target
    |
137 | //! [`HeaderName`] and generic values. This type, like header names, is optimized
    |     ~~~~~~~~~~~~~~

error: could not document `http`


Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions