-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Documentation for documentation
field is misleading
#11777
Comments
Seeing as the individual crate pages will list documentation, I would personally chalk this up as a crates.io bug. From #11685, my suspicion is that this is either an optimization or an oversight. Apparently, adding the docs.rs link to the crate's page is done via Javascript and I imagine doing that for every crate on a search page might be a bit much. |
…nglo docs: Clarify that crates.io doesn't link to docs.rs right away. This implements the suggestion in #11685 (comment) to help clarify the confusion about the documentation link not appearing on crates.io. There may be more to follow up here, perhaps with changes on crates.io or docs.rs, to help with some of the confusion. For example, #11777, or changing crates.io to always link to docs.rs, and have docs.rs provide better error pages when docs aren't available. This is just intended as a short-term fix to address some of the confusion.
…nglo docs: Clarify that crates.io doesn't link to docs.rs right away. This implements the suggestion in #11685 (comment) to help clarify the confusion about the documentation link not appearing on crates.io. There may be more to follow up here, perhaps with changes on crates.io or docs.rs, to help with some of the confusion. For example, #11777, or changing crates.io to always link to docs.rs, and have docs.rs provide better error pages when docs aren't available. This is just intended as a short-term fix to address some of the confusion.
@rustbot label A-documenting-cargo-itself |
This should be reopened since #14562 got reverted. |
The docs for the
documentation
field sayThis sounds as if setting no URL is equivalent to setting the docs.rs URL. That is however not the case: in the crates.io search result list, the "Documentation" link will only show up if
documentation
is explicitly set in the toml file.I am not sure if this is a bug in the cargo docs or the crates.io frontend, but it is certainly surprising.
The text was updated successfully, but these errors were encountered: