Skip to content

Commit

Permalink
update the doc comment on lintchecker b/c it parses html now
Browse files Browse the repository at this point in the history
  • Loading branch information
lolbinarycat committed Aug 24, 2024
1 parent a60a9e5 commit 027c479
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/tools/linkchecker/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@
//! script is to check all relative links in our documentation to make sure they
//! actually point to a valid place.
//!
//! Currently this doesn't actually do any HTML parsing or anything fancy like
//! that, it just has a simple "regex" to search for `href` and `id` tags.
//! Currently uses a combination of HTML parsing to
//! extract the `href` and `id` attributes,
//! and regex search on the orignal markdown to handle intra-doc links.
//!
//! These values are then translated to file URLs if possible and then the
//! destination is asserted to exist.
//!
Expand Down

0 comments on commit 027c479

Please sign in to comment.