Skip to content

No documentation in cargo crate root API reference #5675

@mitchmindtree

Description

@mitchmindtree

Currently there is no documentation at all within the root of the cargo crate API reference - see docs.rs/cargo.

Some sort of guidance for developers on how to get started with using the crate, initial setup (e.g. creating a Config), where to look for certain common patterns and an overview of what each module contains would be a massive help. As a new user of the cargo crate API I have found it very difficult to navigate, spending the last two hours attempting to work all this out in order to solve #5674 to no avail just yet.

I certainly understand that documentation is a non-trivial task, however I just thought I would start an issue for tracking this and share my experience as I surely cannot be the only one who has run into this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-cargo-apiArea: cargo-the-library API and internal code issuesA-documenting-cargo-itselfArea: Cargo's documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions