Documentation for documentation field is misleading
#11777
Labels
A-documenting-cargo-itself
Area: Cargo's documentation
S-blocked-external
Status: ❌ blocked on something out of the direct control of the Cargo project, e.g., upstream fix
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. |
This was referenced May 11, 2023
bors
added a commit
that referenced
this issue
May 16, 2023
…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.
bors
added a commit
that referenced
this issue
May 16, 2023
…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.
This was referenced Mar 27, 2024
|
@rustbot label A-documenting-cargo-itself |
weihanglo
added
the
S-blocked-external
|
This should be reopened since #14562 got reverted. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The docs for the
documentationfield 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
documentationis 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: