Adding `rustdoc-args = ["--generate-link-to-definition"]` in `[package.metadata.docs.rs]` makes documentation coverage dissapear

[carloskiki]

Its seems that all crates that are documented with the option rustdoc-args = ["--generate-link-to-definition"] do not have the "documentation coverage" section in the crates' drop down menu in docs.rs.

For example: clap, vs tokio

Why is that? Why can't there always be the coverage info displayed?

[syphar]

I'm not sure where the problem is here,

my hunch would be that the rustdoc command we generate for coverage can't handle this specific arg, but I need to sift through some logs to find the actual error.

( currently we skip over coverage and just build the docs in case of an error generating coverage)

[carloskiki]

Maybe its with the rustdoc-args parameter as a whole, because there is the --show-coverage argument which you can pass to rustdoc to have an overview of your docs coverage printed to stdout. I assume this argument is used to get the coverage for docs.rs, and it overlaps with crates providing their own set of rustdoc-args.

[syphar]

I needed to jump though some hoops to find the actual error message.

It is :

[stderr] error: --generate-link-to-definition option can only be used with HTML output format

@GuillaumeGomez do you have an idea how to solve this best?

in my mind, we probably need some of the rustdoc-args for coverage, but filtering would be hard.

Could rustdoc just ignore ( and warn) ?

[GuillaumeGomez]

We could indeed emit a warning and mention that the option will be ignored.

[syphar]

We could indeed emit a warning and mention that the option will be ignored.

@GuillaumeGomez that would be awesome, thanks!

[GuillaumeGomez]

Already opened rust-lang/rust#129050. :p

[syphar]

I wonder if we should collect & store the coverage logs too...

[GuillaumeGomez]

I mean, that would have helped here.

[GuillaumeGomez]

rust-lang/rust#129050 is now merged, so tomorrow it should be fixed on docs.rs as well. Closing then.

[syphar]

Just validated that the change in nightly

• is on docs.rs
• is working

( I ran a rebuild for clap, and now we have coverage)