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

Make windows-only APIs show up on docs.rs #3275

Closed
Darksonn opened this issue Dec 14, 2020 · 4 comments
Closed

Make windows-only APIs show up on docs.rs #3275

Darksonn opened this issue Dec 14, 2020 · 4 comments
Labels
A-tokio Area: The main tokio crate T-docs Topic: documentation

Comments

@Darksonn
Copy link
Contributor

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.

@Darksonn Darksonn added E-help-wanted Call for participation: Help is requested to fix this issue. A-tokio Area: The main tokio crate E-medium Call for participation: Experience needed to fix: Medium / intermediate T-docs Topic: documentation labels Dec 14, 2020
@jyn514
Copy link
Contributor

jyn514 commented Dec 29, 2020

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?

@Darksonn
Copy link
Contributor Author

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.

@blasrodri
Copy link
Contributor

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.

@Darksonn Darksonn removed E-help-wanted Call for participation: Help is requested to fix this issue. E-medium Call for participation: Experience needed to fix: Medium / intermediate labels Apr 20, 2024
@Darksonn
Copy link
Contributor Author

This was fixed by 3770.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate T-docs Topic: documentation
Projects
None yet
Development

No branches or pull requests

3 participants