Skip to content

Conversation

@phip1611
Copy link
Member

@phip1611 phip1611 commented Oct 30, 2025

I just couldn't figure out why we need the functionality from #1796 at all. As there is no good reason, we should remove it. If there is, we should add a small comment.

We should release this ASAP as docs.rs is broken currently.

Checklist

  • Sensible git history (for example, squash "typo" or "fix" commits). See the Rewriting History guide for help.
  • Update the changelog (if necessary)
I couldn't figure out why we need it at all. It seems to be a relic from earlier times. Also [0] doesn't provide any reason to keep it. [0] https://docs.rs/about/metadata
@nicholasbishop
Copy link
Member

I think the docs.rs breakage should already be fixed by #1796, once we release it.

The purpose of the feature is to show "badges" on items that require some crate feature to be enabled. E.g. https://docs.rs/uefi/0.35.0/uefi/fs/index.html shows "Available on crate feature alloc only."

@phip1611
Copy link
Member Author

phip1611 commented Oct 30, 2025

Is there any documentation for these badges? I can't find any.

@nicholasbishop
Copy link
Member

I'm not sure if there's any good documentation. The feature is still unstable, hence putting it behind a feature flag that is only enabled on docsrs.

https://doc.rust-lang.org/unstable-book/language-features/doc-cfg.html is the feature doc, but it's not very complete.

Here is a forum post from Tokio about it: https://users.rust-lang.org/t/how-to-document-optional-features-in-api-docs/64577/3

@phip1611
Copy link
Member Author

okay thanks :) then it's okay to keep it

@phip1611 phip1611 closed this Nov 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants