servo / rust-url

URL parser for Rust
https://docs.rs/url/
Apache License 2.0
1.27k stars 317 forks source link

docs: document SyntaxViolation variants, remove bare URLs #924

Closed aatifsyed closed 2 months ago

aatifsyed commented 2 months ago

Fix these errors running cargo doc:

warning: this URL is not a hyperlink
  --> url/src/quirks.rs:68:5
   |
68 | /// https://url.spec.whatwg.org/#dom-url-domaintounicode
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://url.spec.whatwg.org/#dom-url-domaintounicode>`
   |
   = note: bare URLs are not automatically turned into clickable links
   = note: `#[warn(rustdoc::bare_urls)]` on by default

And have SyntaxViolation describe its variants in rustdocs

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

:exclamation: No coverage uploaded for pull request base (main@fd042e0). Click here to learn what that means.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #924 +/- ## ======================================= Coverage ? 81.91% ======================================= Files ? 20 Lines ? 3549 Branches ? 0 ======================================= Hits ? 2907 Misses ? 642 Partials ? 0 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.