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

Remove redundant explicit link target in documentation #88

Merged
merged 1 commit into from
Jan 22, 2024

Conversation

striezel
Copy link

When the CI tries to generate the documentation, it fails with

error: redundant explicit link target
Error:    --> dotenv/src/lib.rs:218:51
    |
218 | /// Loads environment variables from [`io::Read`](std::io::Read).
    |                                       ----------  ^^^^^^^^^^^^^ 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: `-D rustdoc::redundant-explicit-links` implied by `-D warnings`
    = help: to override `-D warnings` add `#[allow(rustdoc::redundant_explicit_links)]`
help: remove explicit link target
    |
218 | /// Loads environment variables from [`io::Read`].
    |                                      ~~~~~~~~~~~~

error: redundant explicit link target

This can be seen in https://github.com/allan2/dotenvy/actions/runs/6670434445/job/18130274835, for example.

All instances of this redundant link target are fixed so that the documentation job should pass again.

When the CI tries to generate the documentation, it fails with

    error: redundant explicit link target
    Error:    --> dotenv/src/lib.rs:218:51
        |
    218 | /// Loads environment variables from [`io::Read`](std::io::Read).
        |                                       ----------  ^^^^^^^^^^^^^ 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: `-D rustdoc::redundant-explicit-links` implied by `-D warnings`
        = help: to override `-D warnings` add `#[allow(rustdoc::redundant_explicit_links)]`
    help: remove explicit link target
        |
    218 | /// Loads environment variables from [`io::Read`].
        |                                      ~~~~~~~~~~~~

    error: redundant explicit link target

All instances of this redundant link target are fixed.
@striezel
Copy link
Author

@allan2: Together with the changes from #87 all CI jobs should be green.

@allan2 allan2 merged commit 34b6955 into allan2:master Jan 22, 2024
7 of 8 checks passed
@allan2
Copy link
Owner

allan2 commented Jan 22, 2024

Thanks! Appreciate your three PRs.

@striezel striezel deleted the remove-redundant-link-targets branch January 23, 2024 02:26
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.

None yet

2 participants