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

Hide winapi's documentation behind a feature flag? #1048

Open
LikeLakers2 opened this issue Sep 21, 2023 · 0 comments
Open

Hide winapi's documentation behind a feature flag? #1048

LikeLakers2 opened this issue Sep 21, 2023 · 0 comments

Comments

@LikeLakers2
Copy link

LikeLakers2 commented Sep 21, 2023

Hi! I'm building a program via the bevy game engine crate, and in the midst of this, I've found it useful to render documentation for everything via cargo doc.

However, I noticed that the winapi crate generates quite a lot of documentation. Unfortunately, cargo doc has no way to exclude certain dependencies without excluding all dependencies (the --exclude flag only seems to work on packages that are within the current workspace).

I don't believe this is an issue with the winapi crate, per se - it's doing its job just fine. However, unless a user is using winapi directly, they may not need to see winapi's documentation anyways - meaning winapi's documentation is simply wasting disk space, and worse, making cargo clean take a lot longer.

Still, some users may need winapi's docs, so hiding them behind a blanket #[doc(hidden)] may not be a good idea. Perhaps winapi could attach #[doc(hidden)] to most stuff, unless a certain feature flag (let's say winapi/render_docs) is specified?

I just think it may be useful to avoid generating so much documentation unless a user needs it.

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