Adding rustdoc-args = ["--generate-link-to-definition"] in [package.metadata.docs.rs] makes documentation coverage dissapear
#2581
Comments
|
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) |
|
Maybe its with the |
|
I needed to jump though some hoops to find the actual error message. It is :
@GuillaumeGomez do you have an idea how to solve this best? in my mind, we probably need some of the Could rustdoc just ignore ( and warn) ? |
|
We could indeed emit a warning and mention that the option will be ignored. |
@GuillaumeGomez that would be awesome, thanks! |
|
Already opened rust-lang/rust#129050. :p |
|
I wonder if we should collect & store the coverage logs too... |
|
I mean, that would have helped here. |
…finition-warning, r=notriddle Emit a warning instead of an error if `--generate-link-to-definition` is used with other output formats than HTML Fixes rust-lang/docs.rs#2581. It's a bit weird to emit an error in this case anyway, a warning is more than enough. r? `@notriddle`
…finition-warning, r=notriddle Emit a warning instead of an error if `--generate-link-to-definition` is used with other output formats than HTML Fixes rust-lang/docs.rs#2581. It's a bit weird to emit an error in this case anyway, a warning is more than enough. r? ``@notriddle``
Rollup merge of rust-lang#129050 - GuillaumeGomez:generate-link-to-definition-warning, r=notriddle Emit a warning instead of an error if `--generate-link-to-definition` is used with other output formats than HTML Fixes rust-lang/docs.rs#2581. It's a bit weird to emit an error in this case anyway, a warning is more than enough. r? ``@notriddle``
|
rust-lang/rust#129050 is now merged, so tomorrow it should be fixed on docs.rs as well. Closing then. |
|
Just validated that the change in nightly
( I ran a rebuild for |
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?
The text was updated successfully, but these errors were encountered: