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

tag things that require features in their rustdoc #25

Closed
Lokathor opened this issue Dec 7, 2021 · 0 comments
Closed

tag things that require features in their rustdoc #25

Lokathor opened this issue Dec 7, 2021 · 0 comments

Comments

@Lokathor
Copy link
Owner

Lokathor commented Dec 7, 2021

The Cargo.toml and lib.rs is already set up for this, we just need to mark individual elements with a doc(cfg()):

Example:

#[cfg_attr(docs_rs, doc(cfg(feature = "alloc")))]

And replace on whatever feature name. This can (I think) go on modules, types, free functions, etc.

Maybe we just need to mark modules and the rest of obvious enough? I guess we don't want to get too spammy with it.

@Lokathor Lokathor added the easy label Dec 7, 2021
@Lokathor Lokathor closed this as completed Aug 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant