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

fixes doc linting error: redundant explicit link target #848

Conversation

nsipplswezey
Copy link
Contributor

@nsipplswezey nsipplswezey commented Oct 19, 2023

API doc build job errors on redundant explicit target.
This removes the redundant explicit target, and passes CI doc build.

error: redundant explicit link target
  --> scylla/src/lib.rs:16:55
   |
16 | //! All driver activity revolves around the [Session](crate::Session)\
   |                                                                          -------  ^^^^^^^^^^^^^^ 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: remove explicit link target

fixes: #847

Pre-review checklist

  • I have split my patch into logically separate commits.
  • All commit messages clearly explain what they change and why.
  • I added relevant tests for new features and bug fixes.
  • All commits compile, pass static checks and pass test.
  • PR description sums up the changes and reasons why they should be introduced.
  • [-] I have provided docstrings for the public items that I want to introduce.
  • [-] I have adjusted the documentation in ./docs/source/.
  • I added appropriate Fixes: annotations to PR description.

error: redundant explicit link target
  --> scylla/src/lib.rs:16:55
   |
16 | //! All driver activity revolves around the [Session](crate::Session)\
   |                                              -------  ^^^^^^^^^^^^^^ 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: remove explicit link target

fixes: scylladb#847
Copy link
Collaborator

@piodul piodul left a comment

Choose a reason for hiding this comment

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

LGTM, thanks.

@piodul piodul merged commit f6eac92 into scylladb:main Oct 19, 2023
8 checks passed
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.

error: redundant explicit link target on cargo_docs CI job
2 participants