diff options
| author | binarycat <binarycat@envs.net> | 2024-08-24 12:35:35 -0400 |
|---|---|---|
| committer | binarycat <binarycat@envs.net> | 2024-08-24 12:35:35 -0400 |
| commit | 027c47983ee161f3346e6be39c14cfc33d03e169 (patch) | |
| tree | 063cd1b7fed01d3278525aeb68b50a8fba4433f5 | |
| parent | a60a9e567a7319b33619f6551dc29522c6f58687 (diff) | |
| download | rust-027c47983ee161f3346e6be39c14cfc33d03e169.tar.gz rust-027c47983ee161f3346e6be39c14cfc33d03e169.zip | |
update the doc comment on lintchecker b/c it parses html now
| -rw-r--r-- | src/tools/linkchecker/main.rs | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/tools/linkchecker/main.rs b/src/tools/linkchecker/main.rs index 72448c1180a..fa77ab1e011 100644 --- a/src/tools/linkchecker/main.rs +++ b/src/tools/linkchecker/main.rs @@ -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. //! |