cc #75, @dtolnay
From rust-cli/env_logger#185:
The scenario where this goes wrong (assuming you're the author of env_logger and not using html_root_url) is:
- Another
downstream crate uses env_logger as a dependency
downstream re-exports or in some other way links to env_logger
- A user or developer of
downstream builds documentation locally with cargo doc --no-deps (without --extern-html-root-url, because in practice no one but docs.rs does that).
Then the links to env_logger will be broken. But there's a simple fix and the fix is to remove --no-deps. Is this really so common that it's worth recommending that library authors use html_root_url?
Note that I'm hoping to fix this properly in cargo instead: rust-lang/cargo#8296
cc #75, @dtolnay
From rust-cli/env_logger#185:
The scenario where this goes wrong (assuming you're the author of
env_loggerand not usinghtml_root_url) is:downstreamcrate usesenv_loggeras a dependencydownstreamre-exports or in some other way links toenv_loggerdownstreambuilds documentation locally withcargo doc --no-deps(without--extern-html-root-url, because in practice no one but docs.rs does that).Then the links to
env_loggerwill be broken. But there's a simple fix and the fix is to remove--no-deps. Is this really so common that it's worth recommending that library authors usehtml_root_url?Note that I'm hoping to fix this properly in cargo instead: rust-lang/cargo#8296