rustc-dev-guide: Missing link in ice-breaker/about.md

I think [claim the issue] is supposed to lead somewhere, but it doesn’t

About this issue

  • Original URL
  • State: closed
  • Created 5 years ago
  • Comments: 15 (15 by maintainers)

Most upvoted comments

@mark-i-m I’ve added initial support for this in mdbook-linkcheck. At the moment pulldown-cmark doesn’t provide the byte index of the broken link, so I’ve implemented a small best-effort hack using string searching.

This sort of incomplete link is valid markdown, so I’m only emitting a warning:

Screenshot from 2019-10-24 14-58-35

I’ll probably create a fail-on-warnings flag for use in CI before making another release.

@amanjeev I think they mean that the [claim this issue] text in https://github.com/rust-lang/rustc-guide/blob/master/src/ice-breaker/about.md is likely supposed to be a link but was not checked.

@Michael-F-Bryan is there any way to make the link checker check these sorts of links?

@spastorino @nikomatsakis What was this supposed to link to?

Just asked @nikomatsakis and indeed he aimed to link to https://github.com/rust-lang/triagebot/wiki/Assignment/. @CreepySkeleton would you like to provide a PR?.

is there any way to make the link checker check these sorts of links?

It is possible, but difficult. pulldown-cmark has a broken link callback, but it doesn’t work very well (it is global, and does not tell you where the link is). I’ve experimented with this in mdBook, and found a ton of false positives, because [foo] is valid markdown, and is intentionally allowed. It might have to be a pedantic-style check, due to the high false positive risk.

Fixing the callback is tracked in https://github.com/raphlinus/pulldown-cmark/issues/165 and https://github.com/raphlinus/pulldown-cmark/issues/373. It is also a blocker for updating pulldown-cmark in rustdoc, so it would be nice to get some movement on it. Someone just needs to propose a good API that could work with pulldown-cmark’s architecture.

There’s a similar issue of broken references are not validated (https://github.com/raphlinus/pulldown-cmark/issues/217).

@mark-i-m

I think they mean that the [claim this issue] text in https://github.com/rust-lang/rustc-guide/blob/master/src/ice-breaker/about.md is likely supposed to be a link but was not checked.

Yes, exactly.

@Michael-F-Bryan is there any way to make the link checker check these sorts of links?

Yes, I’m about to send such a PR.