Description
NOTE: Some cases below assume #63056 has landed.
-
❎ https://doc.rust-lang.org/nightly/core/default/index.html doesn't contain the derive macro
Default
.
✔️ Compare with the https://doc.rust-lang.org/nightly/std/fmt/index.html page which contains the derive macroDebug
because it's introduced through a reexport rather than directly. -
❎ Some built-in macros not available through the libcore root are documented in the root instead (e.g. derives) - https://doc.rust-lang.org/nightly/core/index.html.
-
✔️ libcore prelude is documented correctly https://doc.rust-lang.org/nightly/core/prelude/v1/index.html
-
❎ https://doc.rust-lang.org/nightly/std/default/trait.Default.html doesn't contain the derive macro
Default
.
❎ Note that https://doc.rust-lang.org/nightly/std/fmt/index.html doesn't contain the derive macroDebug
as well. -
❎ Derive and attribute macros in libstd prelude https://doc.rust-lang.org/nightly/std/prelude/v1/index.html has to be marked with
#[doc(hidden)]
currently because otherwise they generate dead links failing thelinkchecker
testing.
As a result they do not appear on the page.
What is worse, due to#[doc(hidden)]
some traits with names matching derives (e.g.Default
) are also not documented at that location.
Activity
pub macro
defined in submodule is shown at the wrong path #74355petrochenkov commentedon Mar 15, 2021
Looks like everything mentioned in this issue was fixed, and #83155 removes the
#[doc(hidden)]
attributes as well.#[doc(hidden)]
from macros in std::prelude. #83155pierwill commentedon Oct 20, 2021
@jyn514 Can we close this?
jyn514 commentedon Oct 20, 2021
My understanding is that the macros with doc(hidden) still aren't documented anywhere, since #83155 was closed.
petrochenkov commentedon Feb 23, 2025
All the issues here are fixed now.