-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
Make windows-only APIs show up on docs.rs #3275
Comments
You can do this the same way as async-std and the standard library: rust-lang/rust#43348, rust-lang/rust#75100. It's documented at https://doc.rust-lang.org/nightly/rustdoc/advanced-features.html#interactions-between-platform-specific-docs. That said, I consider that a misfeature and I really wish rustdoc didn't support it. Could you instead link to the windows docs from the landing page? |
The windows docs are already available if you pick it under the target, but it's not very easily discoverable. I think if we were to avoid this, we would have to add links on the unix types for any type with a windows equivalent. |
Perhaps adding a note on the main page of the docs, alerting non-Linux users that they can click the drop-down to find the docs corresponding to their targets could work. |
This was fixed by 3770. |
Currently all windows-only APIs can only be seen on docs.rs if you choose windows under the target dropdown. Very few people actually do this, so they are easily missed.
There should be some way to make rustdoc generate documentation for them even though the documentation is being generated on Linux.
The text was updated successfully, but these errors were encountered: