orium / cargo-rdme

Cargo command to create the README.md from your crate's documentation
Mozilla Public License 2.0
126 stars 5 forks source link

Intralinks to `impl` items defined in another modules are ignored #170

Open orium opened 1 year ago

orium commented 1 year ago

Currently cargo-rdme only explores modules that are mentioned in the documentation intralinks. This means that do not support mentions to Foo::a_method() in the code below, because module a_mod is not explored.

struct Foo {}

mod a_mod {
    impl Foo {
        fn a_method() {}
    }
}

We would like to support this, but we would have to explore all modules, not only the ones explicitly mentioned. For large crates that can carry a big performance impact.