-
Notifications
You must be signed in to change notification settings - Fork 485
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
windows-core crate should enable implement
feature when building for docs.rs
#2694
Comments
It's not really the https://github.com/microsoft/windows-docs-rs Rust docs are generally miserable for large crates. Something I still need to deal with more fully. |
For the For https://github.com/microsoft/windows-docs-rs you can specify multiple crates, e.g. |
Note that I'm mostly filing this issue on request, otherwise I would have created a PR immediately that adds: [package.metadata.docs.rs]
features = ["implement"]
rustdoc-args = ["--cfg", "docsrs"] # Optional, in case we do the below To #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))] |
Not to worry. It's a little deeper than that as the macros are re-exported through the |
Right, looking at it now the Thanks for looking into it! |
#2696 adds the following: |
@kennykerr Ah so it does turn out that it's only an export from the Anyway, should the docs clarify that that these items are only available when the non-default features are enabled via (Use something like |
Suggestion
I tried very hard to link someone the
#[implement]
docs (there are none to begin with it seems: https://docs.rs/windows-implement/latest/windows_implement/attr.implement.html) viawindows-core
after deducing fromcrates/samples/windows/bits/src/main.rs
that that is where this macro must reside / be reexported from... But couldn't find it.As it turns out the
docs.rs
metadata doesn't turn on this feature (same for thewindows::core
docs generated at https://microsoft.github.io/windows-docs-rs/doc/windows/core/), can this be added so that the documentation is more complete? It could possibly usedoc_cfg
, anddoc_auto_cfg
or a manual#[doc(cfg(feature = "implement"))]
to make it clear that this is not provided by default.Perhaps there are more features that are currently undocumented on docs.rs? I haven't checked.
The text was updated successfully, but these errors were encountered: