linfa icon indicating copy to clipboard operation
linfa copied to clipboard

Broken link in linfa-logistic documentation

Open quietlychris opened this issue 2 years ago • 1 comments

I was just scrolling through a part of of the linfa-logistic, and came across a documentation linking error for the link to https://docs.rs/linfa-logistic/latest/linfa_logistic/struct.LogisticRegression.html from the crate's index page. It might make sense to add a CI check to run a linkchecker over the index.html files created by cargo doc in each of the sub-crates to help keep an eye on this.

One option for this could be the lychee crate, which seems to have a number of installation options (although cargo install probably isn't a good option, since it has something like 400 deps to build from source).

quietlychris avatar Sep 13 '22 22:09 quietlychris

Perhaps #![deny(rustdoc::broken_intra_doc_links)] can be set for the crates?

https://doc.rust-lang.org/rustdoc/lints.html?highlight=link#broken_intra_doc_links

gkobeaga avatar Sep 28 '22 23:09 gkobeaga

Could it be closed?

gkobeaga avatar Oct 13 '22 23:10 gkobeaga

Yep

YuhanLiin avatar Oct 19 '22 03:10 YuhanLiin