On Mon, Mar 24, 2025 at 8:25 PM Daniel Almeida
<daniel.alme...@collabora.com> wrote:
>
> By the way, maybe we should have a lint for CamelCase in docs? I tried my
> best to
> cover all of these, but some slip through :/
>
> i.e.: if you write something in CamelCase somewhere in the docs, there's a
> high
> chance that you should actually use Markdown and link as appropriate.
>
> I have no idea whether this would actually work in practice, to be honest.
> It’s just
> a random suggestion (that I'd be willing to help with).
Yeah, I asked upstream if we could have something that at least
detects what could have been intra-doc links, because that should not
have too many false positives since it is a subset:
https://github.com/rust-lang/rust/issues/131510
It is still tricky, because e.g. `Some` or `None` would need to be
excluded, even if you require the exact same case. So it probably
still requires extra heuristics.
Then there is:
https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
which is closer to your idea. It has a few false positives (e.g.
KUnit) from a quick try, so probably we cannot enable it for
everything, unless we commit to maintain a list of terms in the
config. It spots a handful of things we should fix, though -- I can
send a few patches or create good first issues.
Cheers,
Miguel
