Can you say more about why you want this extra check? I intentionally don't use intra-doc links in the docstrings of private items because no one is going to see them rendered as links anyway, so I think this might not be necessary.

Can you say more about why you want this extra check?

Usually, I always write/use intra-doc links when I document my code. I do not always have in mind whether the documentation will be public or not.

OK, in that case how about adding a --document-private-items flag to cargo xtask doc, so this change can be optional. (I would like the default output of cargo xtask doc to be similar to docs.rs since some areas can be quite cluttered with private stuff enabled -- see BootServices for example.) We can enable the flag in the CI so that it is always checked before merging.

sounds like a good idea! I'll take care of that

I think maybe something got dropped in a rebase? I don't see the code that uses the new flag.

I think maybe something got dropped in a rebase? I don't see the code that uses the new flag.

No, it should be fine. Luckily, we do not have code yet that breaks the lint.

But don't we need a change in xtask/src/cargo.rs to actually pass --document-private-items to cargo doc? Right now you can pass the flag to cargo xtask doc but it doesn't do anything. Unless I'm totally missing something. I am on Amtrak internet right now which feels like 1990s dialup, so github is loading very slowly 😀

Oh, I'm sorry 🙈 You are totally right. No idea how I missed that. Should be fine now? @nicholasbishop

I am on Amtrak internet right now which feels like 1990s dialup, so github is loading very slowly

Believe it or not, but it's 99% oft the time the same with mobile internet in trains in Germany 😆