Unwanted macro re-exports show up in documentation

[Voultapher]

Code

prelude exported macros

Reproduction Steps

1. Open this https://doc.rust-lang.org/std/index.html?search=assert link

Alternatively

1. Export macros directly from the prelude with #[doc(no_inline)]pub use such as here:

   rust/library/std/src/prelude/v1.rs

   Line 49 in 425a9c0

   pub use core::prelude::v1::{

Expected Outcome

If #[doc(no_inline)] is used the re-exported item should not show up.

Actual Output

The re-exported item still shows up.

Version

This issue is not related to a specific browser, it happens with stable, nightly and dev rustdoc.

Additional Details

I noticed this issue while working on #139493, which exacerbates the problem to all prelude macros. And there is a test that checks that typing "prinltn" into the search only returns 3 items and not 6 like it does with the change. Which suggests to me these re-exports are not desirable.

Before:

After:

[lolbinarycat]

If #[doc(no_inline)] is used the re-exported item should not show up.

That's not what no_inline means. Are you confusing this with doc(hidden)? Or you saying that non-inlined re-exports shouldn't show up in search?

I think there is still a bug here, which is that search results should only contain one path for an item under a certain crate (for example, if you search for Option, you won't get any result pointing to the prelude).

[Voultapher]

Based on the documentation https://doc.rust-lang.org/rustdoc/write-documentation/the-doc-attribute.html#inline-and-no_inline

These attributes are used on use statements, and control where the documentation shows up. For example, consider this Rust code:

pub use bar::Bar;

/// bar docs
pub mod bar {
    /// the docs for Bar
    pub struct Bar;
}

The documentation will generate a "Re-exports" section, and say pub use bar::Bar;, where Bar is a link to its page.

[lolbinarycat]

Yes, but that doesn't say anything about what will or will not show in search results.

For example, if you do this:

#[doc(no_inline)]
pub use std::option::Option;

and rustdoc only on this (eg. with --no-deps), you will still get Option in the search results, and it will link to the page with the reexport.

[Voultapher]

Reading https://doc.rust-lang.org/rustdoc/write-documentation/re-exports.html I'm still confused. Why are the stdlib items marked no_inline instead of inline? Clearly we don't want them to show up twice.

[lolbinarycat]

marking it as doc(inline) would not fix this i'm pretty sure. this bug seems unrelated to inlining, and much more related to the fact that these are (builtin) macros.

[Voultapher]

@lolbinarycat do you know what needs to be changed to resolve this issue?

[lolbinarycat]

I imagine there's a pass that makes sure items only have a single path (i'm not sure if it happens in search index generation or earlier), and that pass probably doesn't work properly for built-in macros.