Skip to content

Documentation for documentation field is misleading #11777

Open
@RalfJung

Description

@RalfJung

The docs for the documentation field say

If no URL is specified in the manifest file, crates.io will automatically link your crate to the corresponding docs.rs page.

This 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-documenting-cargo-itselfArea: Cargo's documentationS-blocked-externalStatus: ❌ blocked on something out of the direct control of the Cargo project, e.g., upstream fix

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions