docs(moq-native): fix rustdoc links to quinn-gated items under default features#1961
Merged
Conversation
…t features dev commit ec405f5 made the `noq` backend default and `quinn` a non-default feature, so `pub mod quinn` is `#[cfg(feature = "quinn")]`. Two doc comments still linked to quinn-feature-gated items, which break intra-doc resolution under default features and make `cargo doc --no-deps` (with `-D warnings`) fail. That reds the local `just check` inner loop on a clean `dev`; CI uses `--all-features` so it stayed green. Reword both to plain backtick text so the docs build under both default and `--all-features`. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Sorry @kixelated, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
cargo doc -p moq-native --no-depswith default features fails underRUSTDOCFLAGS="-D warnings"because two doc comments link to items that only exist behind the non-defaultquinnfeature. Dev commit ec405f5 made thenoqbackend the default and gatedpub mod quinnbehind#[cfg(feature = "quinn")], so the links no longer resolve under default features.This makes the local inner-loop
just check(which docs the workspace with default features,rs/justfile:20) red even on a cleandev. CI'sjust rs ciuses--all-features, so it stayed green there.Broken links:
rs/moq-native/src/error.rs—[`crate::quinn::Error`]in theErrorenum doc.rs/moq-native/src/server.rs—[web_transport_quinn::Session]inaccept's doc.Both are reworded to plain backtick text so nothing needs the
quinnfeature to resolve.Test plan
RUSTDOCFLAGS="-D warnings" cargo doc -p moq-native --no-depspasses (previously failed)RUSTDOCFLAGS="-D warnings" cargo doc -p moq-native --no-deps --all-featuresstill passesNo public API or wire change; documentation-only.
(Written by Claude Opus 4.8)