Skip to content

Inconsistent build docs with cargo spec #2772

Open
@nyurik

Description

@nyurik

On the build docs page Setting a README, it says

The README of a crate is taken from the readme field defined in Cargo.toml. If this field is not set, no README will be displayed.

But the cargo reference for the readme field states:

If no value is specified for this field, and a file named README.md, README.txt or README exists in the package root, then the name of that file will be used. You can suppress this behavior by setting this field to false. If the field is set to true, a default value of README.md will be assumed.

Does docs-rs incorrectly state that it will not do the same default readme field resolution, or does it behave differently from cargo?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions