The doc contents are incorrectly made bold under certain situation

[cmpute]

Problem

This bug happens when an associated constant is generated from a generic const function. The brackets surrounding the generic parameters are interpreted as an HTML tag.

Steps

If the documentation is like this in the code:

impl<const A: Word> Repr<A> {
    /// The base of the representation. It's exposed as an [IBig] constant.
    pub const BASE: IBig = base_as_ibig::<A>();
}

The documentation looks like:

(the text becomes a link)

---

If the documentation is

impl<const B: Word> Repr<B> {
    /// The base of the representation. It's exposed as an [IBig] constant.
    pub const BASE: IBig = base_as_ibig::<B>();

    /// Create a [Repr] instance representing value zero
    pub const fn zero() -> Self { todo!() }
}

The documentation looks like

(it even affects the documentation of other items in the same page

Possible Solution(s)

The generic brackets should be escaped

Notes

No response

Version

cargo 1.63.0 (fd9c4297c 2022-07-01)
release: 1.63.0
commit-hash: fd9c4297ccbee36d39e9a79067edab0b614edb5a
commit-date: 2022-07-01
host: x86_64-unknown-linux-gnu
libgit2: 1.4.2 (sys:0.14.2 vendored)
libcurl: 7.83.1-DEV (sys:0.4.55+curl-7.83.1 vendored ssl:OpenSSL/1.1.1n)
os: Ubuntu 20.04 (focal) [64-bit]

[ehuss]

Transferred to rust-lang/rust as that is where rustdoc issues are tracked.

[aDotInTheVoid]

@cmpute I cannot reproduce, can you post the definition of Word, Repr, etc..

---

When I try

pub type Word = usize;
pub struct Repr<const B: usize>([i32; B]);
pub struct IBig(usize);

pub const fn base_as_ibig<const B: Word>() -> IBig {
    IBig(B)
}

impl<const B: Word> Repr<B> {
    /// The base of the representation. It's exposed as an [IBig] constant.
    pub const BASE: IBig = base_as_ibig::<B>();

    /// Create a [Repr] instance representing value zero
    pub const fn zero() -> Self { todo!() }
}

I get

Which looks correct.

It's also possible that I'm on a more recent version of rustdoc, and that this has been fixed, and needs a test

rustdoc 1.65.0-nightly (1120c5e01 2022-09-08)
binary: rustdoc
commit-hash: 1120c5e01df508de64fe6642f22fadeb574afd6d
commit-date: 2022-09-08
host: x86_64-unknown-linux-gnu
release: 1.65.0-nightly
LLVM version: 15.0.0

[cmpute]

I tried to use nightly locally and get the same result as yours. Thanks!

Notice that your rendering output for BASE is

pub const BASE: IBig = _

rather than my rendering:

pub const BASE: IBig = base_as_ibig::()

This actually avoid the problem of parsing the generic parameters <B> as HTML tag, so I think it's fixed in the latest version.