rust-lang-nursery / lazy-static.rs

A small macro for defining lazy evaluated static variables in Rust.
Apache License 2.0
1.9k stars 108 forks source link

How to link to lazy API members in Rust API docs? #211

Open mcandre opened 1 year ago

mcandre commented 1 year ago

I tried the [<entity name here>] syntax cited in the official Rust manual:

https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html

However, this does not appear to be rendering in my package.

/// clean runs [CLEAN_TASKS]. in:

https://github.com/mcandre/cclean/blob/ad448b69fa6f8827da08537d4ceef80c7fc0421d/src/lib.rs#L97

Unfortunately renders as clean runs [CLEAN_TASKS]. (no hyperlink generated) in:

https://docs.rs/cclean/latest/cclean/