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

Promote URLs to hyperlinks in Rustdocs #64

Open
shaneutt opened this issue Oct 19, 2024 · 0 comments
Open

Promote URLs to hyperlinks in Rustdocs #64

shaneutt opened this issue Oct 19, 2024 · 0 comments
Labels
area/maintenance documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed priority/low

Comments

@shaneutt
Copy link
Member

Currently if you build rustdocs for the gateway-api package you'll find that many of the URLs we generate from the upstream Gateway API CRDs get flagged as non-hyperlinks:

$ cargo rustdoc --features k8s-openapi/v1_31 -p gateway-api
warning: this URL is not a hyperlink
   --> gateway-api/src/apis/experimental/grpcroutes.rs:644:9
    |
644 |     /// https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://datatracker.ietf.org/doc/html/rfc2616#section-4.2>`
    |
    = note: bare URLs are not automatically turned into clickable links
    = note: `#[warn(rustdoc::bare_urls)]` on by default

It would be more ideal if we could promote these to automatic links during kopium generate builds as per the suggestion above.

@shaneutt shaneutt added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed area/maintenance priority/low labels Oct 19, 2024
@shaneutt shaneutt added this to the Initial Pre-Release milestone Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/maintenance documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed priority/low
Projects
Status: Backlog
Development

No branches or pull requests

1 participant