Skip to content

Mistake in Documentation #45

Description

@AS1100K

The Path struct has a field name which is documented to only contain it's name without it's complete path, i.e.

use rustdoc_types::Item;

pub struct Bar<'a> {
    pub root_item: &'a Item,
}

Here, name field for the StructField, root_item should be Item but it is rustdoc_types::Item.

File used for docs: https://github.com/AS1100K/cargo-wiki/blob/main/src/generators/module_gen.rs
Generator Used: cargo-wiki, a cargo extension I am working on.

I would be happy to contribute here and open a PR for the same but want to clarify first that this issue is with documentation of rustdoc_types or issue with json generation

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions