servo: Fix as many rustdoc errors as possible

  1. Get Servo building and running on your system
  2. Run ./mach doc
  3. Note the variety of documentation errors that show up during execution
  4. Pick one or more of those errors. For instance:
warning: this URL is not a hyperlink
   --> components/shared/net/request.rs:189:20
    |
189 |     /// Step 12 of https://fetch.spec.whatwg.org/#concept-http-redirect-fetch
    |                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://fetch.spec.whatwg.org/#concept-http-redirect-fetch>`
    |
    = note: bare URLs are not automatically turned into clickable links
    = note: `#[warn(rustdoc::bare_urls)]` on by default

In this case the line should be:

     /// Step 12 of <https://fetch.spec.whatwg.org/#concept-http-redirect-fetch>

About this issue

  • Original URL
  • State: closed
  • Created 3 years ago
  • Comments: 20 (10 by maintainers)

Most upvoted comments

@ektuu Please read the comment that precedes yours.

Hey @ektuu! Thanks for your interest in working on this issue. It’s now assigned to you!

Hey @maureenblack! Thanks for your interest in working on this issue. It’s now assigned to you!