chore: Fix docs.rs build failure - #95
Conversation
kstring fails to build on docs.rs[1] because feature `doc_auto_cfg` was removed from nightly in 1.92.0. Replace it with `doc_cfg`. [1]: https://docs.rs/crate/gstreamer/latest/builds/2623006 Signed-off-by: Marcel Guzik <mguzik555@gmail.com>
|
For verifying this, you recommend $ RUSTFLAGS="--cfg docsrs" cargo +nightly-2025-11-28 checkIn your [package.metadata.docs.rs]
all-features = true
rustc-args = ["--cfg", "docsrs"]
rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]Is there a reason you are using RUSTFLAGS / The reason I'm pushing back on this is because this maintains a brittle state where your ability to be documented is dependent on whether a nightly feature was broken in any of your dependencies that uses it. So far when I've asked about this for any of my packages, no one has had a need for me to merge a fix and publish it. Yes, I'll eventually need to fix this but it is fixed in my repo template and will be propagated here next time I update from the template. |
I see, the problem was with I'll close the issue since it's not blocking anything and you are aware of the feature rename and have the fix ready in the template. Thanks for the clarification! |
|
Note that docs.rs automatically adding that |
This causes enough issues with zizmor
kstring fails to build on docs.rs because feature
doc_auto_cfgwas removed from nightly in 1.92.0.Replace it with
doc_cfg.Fix can be verified using
RUSTFLAGS="--cfg docsrs" cargo +nightly-2025-11-28 check