On Fri Feb 20, 2026 at 12:31 AM JST, Joel Fernandes wrote: > On Thu, Feb 19, 2026 at 02:13:37PM +0900, Alexandre Courbot wrote: >> > + types::Opaque, >> >> Need a `//` or `rustfmt` will reformat. > > Fixed, thanks. > >> > +// SAFETY: [`GpuBuddyInner`] can be sent between threads. >> >> No need to link on non-doccomments. > > Fixed. Removed the brackets from SAFETY comments for GpuBuddyInner > and GpuBuddyGuard. > >> > +/// - `buddy` references a valid [`GpuBuddyInner`]. >> >> rustdoc complains that this links to a private item in a public doc - we >> should not mention `GpuBuddyInner` here. > > Per Miguel's reply, I've kept the mention but removed the square > brackets so it doesn't try to create a link. This way it's still > mentioned for practical reference without triggering the rustdoc > warning.
Won't it be confusing for readers of the public documentation? If a type is private, it shouldn't be needed to folks who read the HTML. This sounds like we instead want a regular `//` comment somewhere to guide those who brave the code.
