Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(hidden) reexports #2472

Closed
flodiebold opened this issue Aug 12, 2021 · 3 comments · Fixed by #2479
Closed

doc(hidden) reexports #2472

flodiebold opened this issue Aug 12, 2021 · 3 comments · Fixed by #2479
Labels

Comments

@flodiebold
Copy link
Member

futures and futures-core reexport a bunch of things with #[doc(hidden)]. rust-analyzer will in the future hide doc(hidden) items from completions and autoimport (it already does so if the item itself is hidden, it's just not handling hidden reexports yet), so if these reexport are actually intended to be used, they probably shouldn't be hidden; they might instead need doc(no_inline) or just no annotation.

CC rust-lang/rust-analyzer#7718 (see the discussion at the end) and rust-lang/rust-analyzer#9197.

@taiki-e
Copy link
Member

taiki-e commented Aug 12, 2021

Thanks for reporting this! Seems doc(no_inline) is better for trait re-exports. (It was quite some time ago that we marked it as doc(hidden) and probably none of us knew about doc(no_inline) at that point.)

@taiki-e taiki-e added the docs label Aug 12, 2021
@nipunn1313
Copy link
Contributor

@rustbot claim

@rustbot
Copy link
Collaborator

rustbot commented Aug 20, 2021

Error: This repository is not enabled to use triagebot.
Add a triagebot.toml in the root of the master branch to enable it.

Please let @rust-lang/release know if you're having trouble with this bot.

nipunn1313 added a commit to nipunn1313/futures-rs that referenced this issue Aug 20, 2021
nipunn1313 added a commit to nipunn1313/futures-rs that referenced this issue Aug 21, 2021
nipunn1313 added a commit to nipunn1313/futures-rs that referenced this issue Aug 22, 2021
taiki-e added a commit to smol-rs/futures-lite that referenced this issue Sep 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants