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

doc_link_code: add check for links with code spans that render weird #14121

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

notriddle
Copy link
Contributor

This is the lint described at rust-lang/rust#136308 (comment) that recommends using HTML to nest links inside code.

changelog: [doc_link_code]: warn when a link with code and a code span are back-to-back

@rustbot
Copy link
Collaborator

rustbot commented Jan 30, 2025

r? @Centri3

rustbot has assigned @Centri3.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Jan 30, 2025
This is the lint described at
rust-lang/rust#136308 (comment)
that recommends using HTML to nest links inside code.
@notriddle
Copy link
Contributor Author

cc @GuillaumeGomez

@GuillaumeGomez
Copy link
Member

Seems surprising to make it a clippy lint. Why not a rustdoc lint instead?

@notriddle
Copy link
Contributor Author

Implementing it in Clippy gives us a chance to shake out any unforeseen corner cases before uplifting it in Rustdoc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants