mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #129512 - lolbinarycat:linkchecker-impl-docs, r=ehuss

Browse Source 
update the doc comment on lintchecker b/c it parses html now
This commit is contained in:
Trevor Gross 2024-08-24 21:03:34 -05:00 committed by GitHub
commit 11ebb597cd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/tools/linkchecker/main.rs
View File

@ -6,8 +6,10 @@
//! script is to check all relative links in our documentation to make sure they //! script is to check all relative links in our documentation to make sure they
//! actually point to a valid place. //! actually point to a valid place.
//! //!
//! Currently this doesn't actually do any HTML parsing or anything fancy like //! Currently uses a combination of HTML parsing to
//! that, it just has a simple "regex" to search for `href` and `id` tags. //! 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 //! These values are then translated to file URLs if possible and then the
//! destination is asserted to exist. //! destination is asserted to exist.
//! //!