about summary refs log tree commit diff
diff options
context:
space:
mode:
authorTrevor Gross <t.gross35@gmail.com>2024-08-24 21:03:34 -0500
committerGitHub <noreply@github.com>2024-08-24 21:03:34 -0500
commit11ebb597cd9f636d4b962c741d7d50a07da869ed (patch)
tree6acbaae7ba281f132277709906cd5e605e153cb8
parent2412d3c31736df4b8a34bead0fdebc32afc140dc (diff)
parent027c47983ee161f3346e6be39c14cfc33d03e169 (diff)
downloadrust-11ebb597cd9f636d4b962c741d7d50a07da869ed.tar.gz
rust-11ebb597cd9f636d4b962c741d7d50a07da869ed.zip
Rollup merge of #129512 - lolbinarycat:linkchecker-impl-docs, r=ehuss
update the doc comment on lintchecker b/c it parses html now
-rw-r--r--src/tools/linkchecker/main.rs6
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.
 //!